Class GetTileRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sagemakergeospatial.model.SageMakerGeospatialRequest
software.amazon.awssdk.services.sagemakergeospatial.model.GetTileRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetTileRequest.Builder,GetTileRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetTileRequest extends SageMakerGeospatialRequest implements ToCopyableBuilder<GetTileRequest.Builder,GetTileRequest>

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the tile operation.

      Returns:
      The Amazon Resource Name (ARN) of the tile operation.

    • executionRoleArn

      public final String executionRoleArn()

      The Amazon Resource Name (ARN) of the IAM role that you specify.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that you specify.

    • hasImageAssets

      public final boolean hasImageAssets()
      For responses, this returns true if the service returned a value for the ImageAssets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • imageAssets

      public final List<String> imageAssets()

      The particular assets or bands to tile.

      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 hasImageAssets() method.

      Returns:
      The particular assets or bands to tile.

    • imageMask

      public final Boolean imageMask()

      Determines whether or not to return a valid data mask.

      Returns:
      Determines whether or not to return a valid data mask.

    • outputDataType

      public final OutputType outputDataType()

      The output data type of the tile operation.

      If the service returns an enum value that is not available in the current SDK version, outputDataType will return OutputType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputDataTypeAsString().

      Returns:
      The output data type of the tile operation.
      See Also:

    • outputDataTypeAsString

      public final String outputDataTypeAsString()

      The output data type of the tile operation.

      If the service returns an enum value that is not available in the current SDK version, outputDataType will return OutputType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputDataTypeAsString().

      Returns:
      The output data type of the tile operation.
      See Also:

    • outputFormat

      public final String outputFormat()

      The data format of the output tile. The formats include .npy, .png and .jpg.

      Returns:
      The data format of the output tile. The formats include .npy, .png and .jpg.

    • propertyFilters

      public final String propertyFilters()

      Property filters for the imagery to tile.

      Returns:
      Property filters for the imagery to tile.

    • target

      public final TargetOptions target()

      Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.

      If the service returns an enum value that is not available in the current SDK version, target will return TargetOptions.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetAsString().

      Returns:
      Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.
      See Also:

    • targetAsString

      public final String targetAsString()

      Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.

      If the service returns an enum value that is not available in the current SDK version, target will return TargetOptions.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetAsString().

      Returns:
      Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.
      See Also:

    • timeRangeFilter

      public final String timeRangeFilter()

      Time range filter applied to imagery to find the images to tile.

      Returns:
      Time range filter applied to imagery to find the images to tile.

    • x

      public final Integer x()

      The x coordinate of the tile input.

      Returns:
      The x coordinate of the tile input.

    • y

      public final Integer y()

      The y coordinate of the tile input.

      Returns:
      The y coordinate of the tile input.

    • z

      public final Integer z()

      The z coordinate of the tile input.

      Returns:
      The z coordinate of the tile input.

    • toBuilder

      public GetTileRequest.Builder 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 interface ToCopyableBuilder<GetTileRequest.Builder,GetTileRequest>
      Specified by:
      toBuilder in class SageMakerGeospatialRequest
      Returns:
      a builder for type T

    • builder

      public static GetTileRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetTileRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.