Class UpdateJobRequest

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

  • Method Details

    • jobId

      public final String jobId()

      The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.

      Returns:
      The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.

    • roleARN

      public final String roleARN()

      The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRoleIdentity and Access Management (IAM) API action.

      Returns:
      The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRoleIdentity and Access Management (IAM) API action.

    • notification

      public final Notification notification()

      The new or updated Notification object.

      Returns:
      The new or updated Notification object.

    • resources

      public final JobResource resources()

      The updated JobResource object, or the updated JobResource object.

      Returns:
      The updated JobResource object, or the updated JobResource object.

    • onDeviceServiceConfiguration

      public final OnDeviceServiceConfiguration onDeviceServiceConfiguration()

      Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon Web Services Storage Gateway service Tape Gateway type.

      Returns:
      Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon Web Services Storage Gateway service Tape Gateway type.

    • addressId

      public final String addressId()

      The ID of the updated Address object.

      Returns:
      The ID of the updated Address object.

    • shippingOption

      public final ShippingOption shippingOption()

      The updated shipping option value of this job's ShippingDetails object.

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

      Returns:
      The updated shipping option value of this job's ShippingDetails object.
      See Also:

    • shippingOptionAsString

      public final String shippingOptionAsString()

      The updated shipping option value of this job's ShippingDetails object.

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

      Returns:
      The updated shipping option value of this job's ShippingDetails object.
      See Also:

    • description

      public final String description()

      The updated description of this job's JobMetadata object.

      Returns:
      The updated description of this job's JobMetadata object.

    • snowballCapacityPreference

      public final SnowballCapacity snowballCapacityPreference()

      The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.

      For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

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

      Returns:
      The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.

      For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

      See Also:

    • snowballCapacityPreferenceAsString

      public final String snowballCapacityPreferenceAsString()

      The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.

      For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

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

      Returns:
      The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.

      For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

      See Also:

    • forwardingAddressId

      public final String forwardingAddressId()

      The updated ID for the forwarding address for a job. This field is not supported in most regions.

      Returns:
      The updated ID for the forwarding address for a job. This field is not supported in most regions.

    • pickupDetails

      public final PickupDetails pickupDetails()
      Returns the value of the PickupDetails property for this object.
      Returns:
      The value of the PickupDetails property for this object.

    • toBuilder

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

    • builder

      public static UpdateJobRequest.Builder builder()

    • serializableBuilderClass

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