Class CreateAssetModelCompositeModelRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest
software.amazon.awssdk.services.iotsitewise.model.CreateAssetModelCompositeModelRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateAssetModelCompositeModelRequest.Builder,CreateAssetModelCompositeModelRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateAssetModelCompositeModelRequest extends IoTSiteWiseRequest implements ToCopyableBuilder<CreateAssetModelCompositeModelRequest.Builder,CreateAssetModelCompositeModelRequest>

  • Method Details

    • assetModelId

      public final String assetModelId()

      The ID of the asset model this composite model is a part of.

      Returns:
      The ID of the asset model this composite model is a part of.

    • assetModelCompositeModelExternalId

      public final String assetModelCompositeModelExternalId()

      An external ID to assign to the composite model.

      If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.

      Returns:
      An external ID to assign to the composite model.

      If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.

    • parentAssetModelCompositeModelId

      public final String parentAssetModelCompositeModelId()

      The ID of the parent composite model in this asset model relationship.

      Returns:
      The ID of the parent composite model in this asset model relationship.

    • assetModelCompositeModelId

      public final String assetModelCompositeModelId()

      The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

      Returns:
      The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

    • assetModelCompositeModelDescription

      public final String assetModelCompositeModelDescription()

      A description for the composite model.

      Returns:
      A description for the composite model.

    • assetModelCompositeModelName

      public final String assetModelCompositeModelName()

      A unique name for the composite model.

      Returns:
      A unique name for the composite model.

    • assetModelCompositeModelType

      public final String assetModelCompositeModelType()

      The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

      Returns:
      The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

    • clientToken

      public final String clientToken()

      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

      Returns:
      A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    • composedAssetModelId

      public final String composedAssetModelId()

      The ID of a component model which is reused to create this composite model.

      Returns:
      The ID of a component model which is reused to create this composite model.

    • hasAssetModelCompositeModelProperties

      public final boolean hasAssetModelCompositeModelProperties()
      For responses, this returns true if the service returned a value for the AssetModelCompositeModelProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • assetModelCompositeModelProperties

      public final List<AssetModelPropertyDefinition> assetModelCompositeModelProperties()

      The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

      You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAssetModelCompositeModelProperties() method.

      Returns:
      The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

      You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.

    • ifMatch

      public final String ifMatch()

      The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The create request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

      Returns:
      The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The create request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

    • ifNoneMatch

      public final String ifNoneMatch()

      Accepts * to reject the create request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.

      Returns:
      Accepts * to reject the create request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.

    • matchForVersionType

      public final AssetModelVersionType matchForVersionType()

      Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the create operation.

      If the service returns an enum value that is not available in the current SDK version, matchForVersionType will return AssetModelVersionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from matchForVersionTypeAsString().

      Returns:
      Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the create operation.
      See Also:

    • matchForVersionTypeAsString

      public final String matchForVersionTypeAsString()

      Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the create operation.

      If the service returns an enum value that is not available in the current SDK version, matchForVersionType will return AssetModelVersionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from matchForVersionTypeAsString().

      Returns:
      Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the create operation.
      See Also:

    • toBuilder

      public CreateAssetModelCompositeModelRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateAssetModelCompositeModelRequest.Builder,CreateAssetModelCompositeModelRequest>
      Specified by:
      toBuilder in class IoTSiteWiseRequest
      Returns:
      a builder for type T

    • builder

      public static CreateAssetModelCompositeModelRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateAssetModelCompositeModelRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.