Interface PropertyDefinitionResponse.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PropertyDefinitionResponse.Builder,PropertyDefinitionResponse>, SdkBuilder<PropertyDefinitionResponse.Builder,PropertyDefinitionResponse>, SdkPojo
Enclosing class:
PropertyDefinitionResponse
@Mutable @NotThreadSafe public static interface PropertyDefinitionResponse.Builder extends SdkPojo, CopyableBuilder<PropertyDefinitionResponse.Builder,PropertyDefinitionResponse>

  • Method Details

    • dataType

      PropertyDefinitionResponse.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 PropertyDefinitionResponse.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:

    • isTimeSeries

      PropertyDefinitionResponse.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.

    • isRequiredInEntity

      PropertyDefinitionResponse.Builder isRequiredInEntity(Boolean isRequiredInEntity)

      A Boolean value that specifies whether the property is required in an entity.

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

    • isExternalId

      PropertyDefinitionResponse.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

      PropertyDefinitionResponse.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.

    • isImported

      PropertyDefinitionResponse.Builder isImported(Boolean isImported)

      A Boolean value that specifies whether the property definition is imported from an external data store.

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

    • isFinal

      PropertyDefinitionResponse.Builder isFinal(Boolean isFinal)

      A Boolean value that specifies whether the property definition can be updated.

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

    • isInherited

      PropertyDefinitionResponse.Builder isInherited(Boolean isInherited)

      A Boolean value that specifies whether the property definition is inherited from a parent entity.

      Parameters:
      isInherited - A Boolean value that specifies whether the property definition is inherited from a parent entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultValue

      PropertyDefinitionResponse.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 PropertyDefinitionResponse.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

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

      A mapping that specifies configuration information about the property.

      Parameters:
      configuration - A mapping that specifies configuration information about the property.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      PropertyDefinitionResponse.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.