Interface PropertyDefinitionRequest.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PropertyDefinitionRequest.Builder,PropertyDefinitionRequest>, SdkBuilder<PropertyDefinitionRequest.Builder,PropertyDefinitionRequest>, SdkPojo
Enclosing class:
PropertyDefinitionRequest
public static interface PropertyDefinitionRequest.Builder extends SdkPojo, CopyableBuilder<PropertyDefinitionRequest.Builder,PropertyDefinitionRequest>

  • Method Details

    • dataType

      PropertyDefinitionRequest.Builder dataType(DataType dataType)

      An object that contains information about the data type.

      Parameters:
      dataType - An object that contains information about the data type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataType

      default PropertyDefinitionRequest.Builder dataType(Consumer<DataType.Builder> dataType)

      An object that contains information about the data type.

      This is a convenience method that creates an instance of the DataType.Builder avoiding the need to create one manually via DataType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataType(DataType).

      Parameters:
      dataType - a consumer that will call methods on DataType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • isRequiredInEntity

      PropertyDefinitionRequest.Builder isRequiredInEntity(Boolean isRequiredInEntity)

      A Boolean value that specifies whether the property is required.

      Parameters:
      isRequiredInEntity - A Boolean value that specifies whether the property is required.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isExternalId

      PropertyDefinitionRequest.Builder isExternalId(Boolean isExternalId)

      A Boolean value that specifies whether the property ID comes from an external data store.

      Parameters:
      isExternalId - A Boolean value that specifies whether the property ID comes from an external data store.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isStoredExternally

      PropertyDefinitionRequest.Builder isStoredExternally(Boolean isStoredExternally)

      A Boolean value that specifies whether the property is stored externally.

      Parameters:
      isStoredExternally - A Boolean value that specifies whether the property is stored externally.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isTimeSeries

      PropertyDefinitionRequest.Builder isTimeSeries(Boolean isTimeSeries)

      A Boolean value that specifies whether the property consists of time series data.

      Parameters:
      isTimeSeries - A Boolean value that specifies whether the property consists of time series data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultValue

      PropertyDefinitionRequest.Builder defaultValue(DataValue defaultValue)

      An object that contains the default value.

      Parameters:
      defaultValue - An object that contains the default value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultValue

      default PropertyDefinitionRequest.Builder defaultValue(Consumer<DataValue.Builder> defaultValue)

      An object that contains the default value.

      This is a convenience method that creates an instance of the DataValue.Builder avoiding the need to create one manually via DataValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultValue(DataValue).

      Parameters:
      defaultValue - a consumer that will call methods on DataValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • configuration

      PropertyDefinitionRequest.Builder configuration(Map<String,String> configuration)

      A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.

      Parameters:
      configuration - A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      PropertyDefinitionRequest.Builder displayName(String displayName)

      A friendly name for the property.

      Parameters:
      displayName - A friendly name for the property.
      Returns:
      Returns a reference to this object so that method calls can be chained together.