Class CreateJobRequest

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

  • Method Details

    • accountId

      public final String accountId()

      The Amazon Web Services account ID that creates the job.

      Returns:
      The Amazon Web Services account ID that creates the job.

    • confirmationRequired

      public final Boolean confirmationRequired()

      Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

      Returns:
      Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

    • operation

      public final JobOperation operation()

      The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

      Returns:
      The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

    • report

      public final JobReport report()

      Configuration parameters for the optional job-completion report.

      Returns:
      Configuration parameters for the optional job-completion report.

    • clientRequestToken

      public final String clientRequestToken()

      An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

      Returns:
      An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

    • manifest

      public final JobManifest manifest()

      Configuration parameters for the manifest.

      Returns:
      Configuration parameters for the manifest.

    • description

      public final String description()

      A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

      Returns:
      A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

    • priority

      public final Integer priority()

      The numerical priority for this job. Higher numbers indicate higher priority.

      Returns:
      The numerical priority for this job. Higher numbers indicate higher priority.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.

      Returns:
      The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.

    • 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 List<S3Tag> tags()

      A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

      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:
      A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

    • manifestGenerator

      public final JobManifestGenerator manifestGenerator()

      The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

      Returns:
      The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

    • toBuilder

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

    • builder

      public static CreateJobRequest.Builder builder()

    • serializableBuilderClass

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