Class StartJobRequest

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

  • Method Details

    • clientToken

      public final String clientToken()

      A unique identifier for this request to ensure idempotency.

      Returns:
      A unique identifier for this request to ensure idempotency.

    • action

      public final JobAction action()

      The action to perform on the input data.

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

      Returns:
      The action to perform on the input data.
      See Also:

    • actionAsString

      public final String actionAsString()

      The action to perform on the input data.

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

      Returns:
      The action to perform on the input data.
      See Also:

    • actionOptions

      public final JobActionOptions actionOptions()

      Additional parameters that can be requested for each result.

      Returns:
      Additional parameters that can be requested for each result.

    • executionRoleArn

      public final String executionRoleArn()

      The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.

      The IAM role must be created in the same Amazon Web Services account where you plan to run your job.

      For more information about configuring IAM roles for Amazon Location jobs, see Configure IAM permissions in the Amazon Location Service Developer Guide.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.

      The IAM role must be created in the same Amazon Web Services account where you plan to run your job.

      For more information about configuring IAM roles for Amazon Location jobs, see Configure IAM permissions in the Amazon Location Service Developer Guide.

    • inputOptions

      public final JobInputOptions inputOptions()

      Configuration for input data location and format.

      Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.

      Returns:
      Configuration for input data location and format.

      Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.

    • name

      public final String name()

      An optional name for the job resource.

      Returns:
      An optional name for the job resource.

    • outputOptions

      public final JobOutputOptions outputOptions()

      Configuration for output data location and format.

      Returns:
      Configuration for output data location and format.

    • 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 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.

    • tags

      public final Map<String,String> tags()

      Tags and corresponding values to be associated with the job.

      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 and corresponding values to be associated with the job.

    • toBuilder

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

    • builder

      public static StartJobRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartJobRequest.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.