Class UpdateAssetModelCompositeModelRequest
- 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.UpdateAssetModelCompositeModelRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateAssetModelCompositeModelRequest.Builder,UpdateAssetModelCompositeModelRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateAssetModelCompositeModelRequest extends IoTSiteWiseRequest implements ToCopyableBuilder<UpdateAssetModelCompositeModelRequest.Builder,UpdateAssetModelCompositeModelRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateAssetModelCompositeModelRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringassetModelCompositeModelDescription()A description for the composite model.StringassetModelCompositeModelExternalId()An external ID to assign to the asset model.StringassetModelCompositeModelId()The ID of a composite model on this asset model.StringassetModelCompositeModelName()A unique name for the composite model.List<AssetModelProperty>assetModelCompositeModelProperties()The property definitions of the composite model.StringassetModelId()The ID of the asset model, in UUID format.static UpdateAssetModelCompositeModelRequest.Builderbuilder()StringclientToken()A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAssetModelCompositeModelProperties()For responses, this returns true if the service returned a value for the AssetModelCompositeModelProperties property.inthashCode()StringifMatch()The expected current entity tag (ETag) for the asset model’s latest or active version (specified usingmatchForVersionType).StringifNoneMatch()Accepts * to reject the update request if an active version (specified usingmatchForVersionTypeasACTIVE) already exists for the asset model.AssetModelVersionTypematchForVersionType()Specifies the asset model version type (LATESTorACTIVE) used in conjunction withIf-MatchorIf-None-Matchheaders to determine the target ETag for the update operation.StringmatchForVersionTypeAsString()Specifies the asset model version type (LATESTorACTIVE) used in conjunction withIf-MatchorIf-None-Matchheaders to determine the target ETag for the update operation.List<SdkField<?>>sdkFields()static Class<? extends UpdateAssetModelCompositeModelRequest.Builder>serializableBuilderClass()UpdateAssetModelCompositeModelRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
assetModelId
public final String assetModelId()
The ID of the asset model, in UUID format.
- Returns:
- The ID of the asset model, in UUID format.
-
assetModelCompositeModelId
public final String assetModelCompositeModelId()
The ID of a composite model on this asset model.
- Returns:
- The ID of a composite model on this asset model.
-
assetModelCompositeModelExternalId
public final String assetModelCompositeModelExternalId()
An external ID to assign to the asset model. You can only set the external ID of the asset model if it wasn't set when it was created, or you're setting it to the exact same thing as when it was created.
- Returns:
- An external ID to assign to the asset model. You can only set the external ID of the asset model if it wasn't set when it was created, or you're setting it to the exact same thing as when it was created.
-
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.
-
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.
-
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 theisEmpty()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<AssetModelProperty> 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 update 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 update 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 update request if an active version (specified using
matchForVersionTypeasACTIVE) already exists for the asset model.- Returns:
- Accepts * to reject the update request if an active version (specified using
matchForVersionTypeasACTIVE) already exists for the asset model.
-
matchForVersionType
public final AssetModelVersionType matchForVersionType()
Specifies the asset model version type (
LATESTorACTIVE) used in conjunction withIf-MatchorIf-None-Matchheaders to determine the target ETag for the update operation.If the service returns an enum value that is not available in the current SDK version,
matchForVersionTypewill returnAssetModelVersionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommatchForVersionTypeAsString().- Returns:
- Specifies the asset model version type (
LATESTorACTIVE) used in conjunction withIf-MatchorIf-None-Matchheaders to determine the target ETag for the update operation. - See Also:
AssetModelVersionType
-
matchForVersionTypeAsString
public final String matchForVersionTypeAsString()
Specifies the asset model version type (
LATESTorACTIVE) used in conjunction withIf-MatchorIf-None-Matchheaders to determine the target ETag for the update operation.If the service returns an enum value that is not available in the current SDK version,
matchForVersionTypewill returnAssetModelVersionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommatchForVersionTypeAsString().- Returns:
- Specifies the asset model version type (
LATESTorACTIVE) used in conjunction withIf-MatchorIf-None-Matchheaders to determine the target ETag for the update operation. - See Also:
AssetModelVersionType
-
toBuilder
public UpdateAssetModelCompositeModelRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateAssetModelCompositeModelRequest.Builder,UpdateAssetModelCompositeModelRequest>- Specified by:
toBuilderin classIoTSiteWiseRequest
-
builder
public static UpdateAssetModelCompositeModelRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateAssetModelCompositeModelRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-