software.amazon.awssdk.services.s3control.model

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() The AWS account ID that creates the job.
static CreateJobRequest.Builder	builder()
String	clientRequestToken() An idempotency token to ensure that you don't accidentally submit the same request twice.
Boolean	confirmationRequired() Indicates whether confirmation is required before Amazon S3 runs the job.
String	description() A description for this job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
JobManifest	manifest() Configuration parameters for the manifest.
JobOperation	operation() The operation that you want this job to perform on every object listed in the manifest.
Integer	priority() The numerical priority for this job.
JobReport	report() Configuration parameters for the optional job-completion report.
String	roleArn() The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that Batch Operations will use to run this job's operation on every object in the manifest.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateJobRequest.Builder>	serializableBuilderClass()
List<S3Tag>	tags() A set of tags to associate with the S3 Batch Operations job.
CreateJobRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

accountId

public final String accountId()

The AWS account ID that creates the job.

Returns:

The AWS 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 operation that you want this job to perform on every object listed in the manifest. For more information about the available operations, see Operations in the Amazon Simple Storage Service Developer Guide.

Returns:

The operation that you want this job to perform on every object listed in the manifest. For more information about the available operations, see Operations in the Amazon Simple Storage Service Developer 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 AWS Identity and Access Management (IAM) role that Batch Operations will use to run this job's operation on every object in the manifest.

Returns:

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

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasTags() to see if a value was sent in this field.

Returns:

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

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.