Class GetMlInputChannelResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.cleanroomsml.model.CleanRoomsMlResponse
-
- software.amazon.awssdk.services.cleanroomsml.model.GetMlInputChannelResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetMlInputChannelResponse.Builder,GetMlInputChannelResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetMlInputChannelResponse extends CleanRoomsMlResponse implements ToCopyableBuilder<GetMlInputChannelResponse.Builder,GetMlInputChannelResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetMlInputChannelResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetMlInputChannelResponse.Builderbuilder()StringcollaborationIdentifier()The collaboration ID of the collaboration that contains the ML input channel.List<String>configuredModelAlgorithmAssociations()The configured model algorithm associations that were used to create the ML input channel.InstantcreateTime()The time at which the ML input channel was created.Stringdescription()The description of the ML input channel.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasConfiguredModelAlgorithmAssociations()For responses, this returns true if the service returned a value for the ConfiguredModelAlgorithmAssociations property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.InputChannelinputChannel()The input channel that was used to create the ML input channel.StringkmsKeyArn()The Amazon Resource Name (ARN) of the KMS key that was used to create the ML input channel.StringmembershipIdentifier()The membership ID of the membership that contains the ML input channel.StringmlInputChannelArn()The Amazon Resource Name (ARN) of the ML input channel.Stringname()The name of the ML input channel.DoublenumberOfFiles()The number of files in the ML input channel.LongnumberOfRecords()The number of records in the ML input channel.StringprotectedQueryIdentifier()The ID of the protected query that was used to create the ML input channel.IntegerretentionInDays()The number of days to keep the data in the ML input channel.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends GetMlInputChannelResponse.Builder>serializableBuilderClass()DoublesizeInGb()The size, in GB, of the ML input channel.MLInputChannelStatusstatus()The status of the ML input channel.StringstatusAsString()The status of the ML input channel.StatusDetailsstatusDetails()Returns the value of the StatusDetails property for this object.Map<String,String>tags()The optional metadata that you applied to the resource to help you categorize and organize them.GetMlInputChannelResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdateTime()The most recent time at which the ML input channel was updated.-
Methods inherited from class software.amazon.awssdk.services.cleanroomsml.model.CleanRoomsMlResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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
-
createTime
public final Instant createTime()
The time at which the ML input channel was created.
- Returns:
- The time at which the ML input channel was created.
-
updateTime
public final Instant updateTime()
The most recent time at which the ML input channel was updated.
- Returns:
- The most recent time at which the ML input channel was updated.
-
membershipIdentifier
public final String membershipIdentifier()
The membership ID of the membership that contains the ML input channel.
- Returns:
- The membership ID of the membership that contains the ML input channel.
-
collaborationIdentifier
public final String collaborationIdentifier()
The collaboration ID of the collaboration that contains the ML input channel.
- Returns:
- The collaboration ID of the collaboration that contains the ML input channel.
-
inputChannel
public final InputChannel inputChannel()
The input channel that was used to create the ML input channel.
- Returns:
- The input channel that was used to create the ML input channel.
-
protectedQueryIdentifier
public final String protectedQueryIdentifier()
The ID of the protected query that was used to create the ML input channel.
- Returns:
- The ID of the protected query that was used to create the ML input channel.
-
mlInputChannelArn
public final String mlInputChannelArn()
The Amazon Resource Name (ARN) of the ML input channel.
- Returns:
- The Amazon Resource Name (ARN) of the ML input channel.
-
name
public final String name()
The name of the ML input channel.
- Returns:
- The name of the ML input channel.
-
hasConfiguredModelAlgorithmAssociations
public final boolean hasConfiguredModelAlgorithmAssociations()
For responses, this returns true if the service returned a value for the ConfiguredModelAlgorithmAssociations 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.
-
configuredModelAlgorithmAssociations
public final List<String> configuredModelAlgorithmAssociations()
The configured model algorithm associations that were used to create the ML input channel.
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
hasConfiguredModelAlgorithmAssociations()method.- Returns:
- The configured model algorithm associations that were used to create the ML input channel.
-
status
public final MLInputChannelStatus status()
The status of the ML input channel.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnMLInputChannelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the ML input channel.
- See Also:
MLInputChannelStatus
-
statusAsString
public final String statusAsString()
The status of the ML input channel.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnMLInputChannelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the ML input channel.
- See Also:
MLInputChannelStatus
-
statusDetails
public final StatusDetails statusDetails()
Returns the value of the StatusDetails property for this object.- Returns:
- The value of the StatusDetails property for this object.
-
retentionInDays
public final Integer retentionInDays()
The number of days to keep the data in the ML input channel.
- Returns:
- The number of days to keep the data in the ML input channel.
-
numberOfRecords
public final Long numberOfRecords()
The number of records in the ML input channel.
- Returns:
- The number of records in the ML input channel.
-
numberOfFiles
public final Double numberOfFiles()
The number of files in the ML input channel.
- Returns:
- The number of files in the ML input channel.
-
sizeInGb
public final Double sizeInGb()
The size, in GB, of the ML input channel.
- Returns:
- The size, in GB, of the ML input channel.
-
description
public final String description()
The description of the ML input channel.
- Returns:
- The description of the ML input channel.
-
kmsKeyArn
public final String kmsKeyArn()
The Amazon Resource Name (ARN) of the KMS key that was used to create the ML input channel.
- Returns:
- The Amazon Resource Name (ARN) of the KMS key that was used to create the ML input channel.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags 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.
-
tags
public final Map<String,String> tags()
The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50.
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8.
-
Maximum value length - 256 Unicode characters in UTF-8.
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case sensitive.
-
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
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
hasTags()method.- Returns:
- The optional metadata that you applied to the resource to help you categorize and organize them. Each tag
consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50.
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8.
-
Maximum value length - 256 Unicode characters in UTF-8.
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case sensitive.
-
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
-
-
-
toBuilder
public GetMlInputChannelResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetMlInputChannelResponse.Builder,GetMlInputChannelResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetMlInputChannelResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetMlInputChannelResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
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 classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-