Class GetBlueprintResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetBlueprintResponse.Builder,GetBlueprintResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal StringThe Amazon Resource Name (ARN) of the blueprint.final StringThe name of the blueprint.final StringThe version of the blueprint.static GetBlueprintResponse.Builderbuilder()final InstantThe date and time that the blueprint was created.final booleanfinal booleanequalsBySdkFields(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 inthashCode()final booleanFor responses, this returns true if the service returned a value for the KmsEncryptionContext property.The AWS KMS encryption context used when encrypting the blueprint.final StringkmsKeyId()The identifier of the AWS KMS key used to encrypt the blueprint.final InstantThe date and time that the blueprint was last modified.final Stringschema()The schema of the blueprint, which defines the fields to extract and their expected structure.static Class<? extends GetBlueprintResponse.Builder> 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.services.textract.model.TextractResponse
responseMetadataMethods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponseMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
blueprintArn
The Amazon Resource Name (ARN) of the blueprint.
- Returns:
- The Amazon Resource Name (ARN) of the blueprint.
-
blueprintName
-
blueprintVersion
The version of the blueprint.
- Returns:
- The version of the blueprint.
-
schema
The schema of the blueprint, which defines the fields to extract and their expected structure.
- Returns:
- The schema of the blueprint, which defines the fields to extract and their expected structure.
-
kmsKeyId
The identifier of the AWS KMS key used to encrypt the blueprint.
- Returns:
- The identifier of the AWS KMS key used to encrypt the blueprint.
-
hasKmsEncryptionContext
public final boolean hasKmsEncryptionContext()For responses, this returns true if the service returned a value for the KmsEncryptionContext 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. -
kmsEncryptionContext
The AWS KMS encryption context used when encrypting the blueprint.
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
hasKmsEncryptionContext()method.- Returns:
- The AWS KMS encryption context used when encrypting the blueprint.
-
creationTime
The date and time that the blueprint was created.
- Returns:
- The date and time that the blueprint was created.
-
lastModifiedTime
The date and time that the blueprint was last modified.
- Returns:
- The date and time that the blueprint was last modified.
-
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<GetBlueprintResponse.Builder,GetBlueprintResponse> - Specified by:
toBuilderin classAwsResponse- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsResponse
-
equals
- Overrides:
equalsin classAwsResponse
-
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:SdkResponseUsed 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:
getValueForFieldin 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:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-