Class CreateEndpointRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateEndpointRequest.Builder,
CreateEndpointRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
An idempotency token provided by the customer.final String
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).final Integer
The desired number of inference units to be used by the model using this endpoint.final String
This is the descriptive suffix that becomes part of theEndpointArn
used for all subsequent requests to this resource.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
modelArn()
The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.static Class
<? extends CreateEndpointRequest.Builder> tags()
Tags to associate with the endpoint.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
endpointName
This is the descriptive suffix that becomes part of the
EndpointArn
used for all subsequent requests to this resource.- Returns:
- This is the descriptive suffix that becomes part of the
EndpointArn
used for all subsequent requests to this resource.
-
modelArn
The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
- Returns:
- The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
-
desiredInferenceUnits
The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
- Returns:
- The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.
-
clientRequestToken
An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a
ResourceInUseException
.- Returns:
- An idempotency token provided by the customer. If this token matches a previous endpoint creation
request, Amazon Comprehend will not return a
ResourceInUseException
.
-
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
Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
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:
- Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.
-
dataAccessRoleArn
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
- Returns:
- The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).
-
flywheelArn
The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
- Returns:
- The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.
-
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<CreateEndpointRequest.Builder,
CreateEndpointRequest> - Specified by:
toBuilder
in classComprehendRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
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
Description copied from class:SdkRequest
Used 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:
getValueForField
in 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
-