GetTileRequest (AWS Java SDK :: Services :: Sage Maker Geospatial 2.20.103 API)

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(value="software.amazon.awssdk:codegen")
public final class GetTileRequest
extends SageMakerGeospatialRequest
implements ToCopyableBuilder<GetTileRequest.Builder,GetTileRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetTileRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetTileRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the tile operation.
`static GetTileRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executionRoleArn()` The Amazon Resource Name (ARN) of the IAM role that you specify.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasImageAssets()` For responses, this returns true if the service returned a value for the ImageAssets property.
`List<String>`	`imageAssets()` The particular assets or bands to tile.
`Boolean`	`imageMask()` Determines whether or not to return a valid data mask.
`OutputType`	`outputDataType()` The output data type of the tile operation.
`String`	`outputDataTypeAsString()` The output data type of the tile operation.
`String`	`outputFormat()` The data format of the output tile.
`String`	`propertyFilters()` Property filters for the imagery to tile.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetTileRequest.Builder>`	`serializableBuilderClass()`
`TargetOptions`	`target()` Determines what part of the Earth Observation job to tile.
`String`	`targetAsString()` Determines what part of the Earth Observation job to tile.
`String`	`timeRangeFilter()` Time range filter applied to imagery to find the images to tile.
`GetTileRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Integer`	`x()` The x coordinate of the tile input.
`Integer`	`y()` The y coordinate of the tile input.
`Integer`	`z()` The z coordinate of the tile input.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    OutputType
  - 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:
    
    OutputType
  - 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:
    
    TargetOptions
  - 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:
    
    TargetOptions
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetTileRequest.Builder,GetTileRequest>
    
    Specified by:
    
    toBuilder in class SageMakerGeospatialRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetTileRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

executionRoleArn

hasImageAssets

imageAssets

imageMask

outputDataType

outputDataTypeAsString

outputFormat

propertyFilters

target

targetAsString

timeRangeFilter

x

y

z

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields