Class GetMlInputChannelResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetMlInputChannelResponse.Builder,
GetMlInputChannelResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The collaboration ID of the collaboration that contains the ML input channel.The configured model algorithm associations that were used to create the ML input channel.final Instant
The time at which the ML input channel was created.final String
The description of the ML input channel.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the ConfiguredModelAlgorithmAssociations property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final InputChannel
The input channel that was used to create the ML input channel.final String
The Amazon Resource Name (ARN) of the KMS key that was used to create the ML input channel.final String
The membership ID of the membership that contains the ML input channel.final String
The Amazon Resource Name (ARN) of the ML input channel.final String
name()
The name of the ML input channel.final Double
The number of files in the ML input channel.final Long
The number of records in the ML input channel.final String
The ID of the protected query that was used to create the ML input channel.final Integer
The number of days to keep the data in the ML input channel.static Class
<? extends GetMlInputChannelResponse.Builder> final Double
sizeInGb()
The size, in GB, of the ML input channel.final MLInputChannelStatus
status()
The status of the ML input channel.final String
The status of the ML input channel.final StatusDetails
Returns the value of the StatusDetails property for this object.tags()
The optional metadata that you applied to the resource to help you categorize and organize them.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
createTime
The time at which the ML input channel was created.
- Returns:
- The time at which the ML input channel was created.
-
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
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
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
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
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
The Amazon Resource Name (ARN) of the ML input channel.
- Returns:
- The Amazon Resource Name (ARN) of the ML input channel.
-
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
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
The status of the ML input channel.
If the service returns an enum value that is not available in the current SDK version,
status
will 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:
-
statusAsString
The status of the ML input channel.
If the service returns an enum value that is not available in the current SDK version,
status
will 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:
-
statusDetails
Returns the value of the StatusDetails property for this object.- Returns:
- The value of the StatusDetails property for this object.
-
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
The number of records in the ML input channel.
- Returns:
- The number of records in the ML input channel.
-
numberOfFiles
The number of files in the ML input channel.
- Returns:
- The number of files in the ML input channel.
-
sizeInGb
The size, in GB, of the ML input channel.
- Returns:
- The size, in GB, of the ML input channel.
-
description
The description of the ML input channel.
- Returns:
- The description of the ML input channel.
-
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
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
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 interfaceToCopyableBuilder<GetMlInputChannelResponse.Builder,
GetMlInputChannelResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-