Class CreateGlobalInferenceGatewayRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateGlobalInferenceGatewayRequest.Builder,CreateGlobalInferenceGatewayRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final StringA unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final StringThe Amazon Resource Name (ARN) of the IAM role that the global inference gateway assumes to access your SageMaker HyperPod clusters.final List<GlobalInferenceGatewayMember> gateways()The 1 to 10 in-cluster inference gateways to add to the global inference gateway.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final booleanFor responses, this returns true if the service returned a value for the Gateways property.final inthashCode()final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final Stringname()The name of the global inference gateway.routing()The routing configuration of the global inference gateway.static Class<? extends CreateGlobalInferenceGatewayRequest.Builder> tags()Custom tags for managing the global inference gateway as an Amazon Web Services resource.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the global inference gateway. The name must be unique in your account in the current Region, and is case-sensitive. The name can't be exactly 12 lowercase letters or digits, because the global inference gateway ID uses that format.
- Returns:
- The name of the global inference gateway. The name must be unique in your account in the current Region, and is case-sensitive. The name can't be exactly 12 lowercase letters or digits, because the global inference gateway ID uses that format.
-
routing
The routing configuration of the global inference gateway. If you omit it, the global inference gateway uses default routing weights.
- Returns:
- The routing configuration of the global inference gateway. If you omit it, the global inference gateway uses default routing weights.
-
executionRoleArn
The Amazon Resource Name (ARN) of the IAM role that the global inference gateway assumes to access your SageMaker HyperPod clusters. The role must be in your account and partition, and you must have
iam:PassRolepermission for it. You can't change the role after you create the global inference gateway.- Returns:
- The Amazon Resource Name (ARN) of the IAM role that the global inference gateway assumes to access your
SageMaker HyperPod clusters. The role must be in your account and partition, and you must have
iam:PassRolepermission for it. You can't change the role after you create the global inference gateway.
-
hasGateways
public final boolean hasGateways()For responses, this returns true if the service returned a value for the Gateways 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. -
gateways
The 1 to 10 in-cluster inference gateways to add to the global inference gateway. A global inference gateway must always have at least one in-cluster inference gateway, so
RemoveInferenceGatewaycan't remove the last one.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
hasGateways()method.- Returns:
- The 1 to 10 in-cluster inference gateways to add to the global inference gateway. A global inference
gateway must always have at least one in-cluster inference gateway, so
RemoveInferenceGatewaycan't remove the last one.
-
clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. An idempotent operation completes no more than one time. If you don't specify a client token, the Amazon Web Services SDKs and the Amazon Web Services CLI generate one for you.
- Returns:
- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. An idempotent operation completes no more than one time. If you don't specify a client token, the Amazon Web Services SDKs and the Amazon Web Services CLI generate one for you.
-
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
Custom tags for managing the global inference gateway as an Amazon Web Services resource. You can add tags to your global inference gateway in the same way you add them in other Amazon Web Services services that support tagging. For more information about tagging Amazon Web Services resources, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.
The global inference gateway doesn't return tags in its responses. To read the tags, use
ListTags.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:
- Custom tags for managing the global inference gateway as an Amazon Web Services resource. You can add
tags to your global inference gateway in the same way you add them in other Amazon Web Services services
that support tagging. For more information about tagging Amazon Web Services resources, see Tagging your Amazon Web
Services resources in the Tagging Amazon Web Services Resources User Guide.
The global inference gateway doesn't return tags in its responses. To read the tags, use
ListTags.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateGlobalInferenceGatewayRequest.Builder,CreateGlobalInferenceGatewayRequest> - Specified by:
toBuilderin classSageMakerRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends CreateGlobalInferenceGatewayRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin 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:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. 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, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- 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:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-