@Generated(value="software.amazon.awssdk:codegen") public final class CreateJobRequest extends S3ControlRequest implements ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateJobRequest.Builder |
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.
|
overrideConfiguration
copy
public final String accountId()
The AWS account ID that creates the job.
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.
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.
public final JobReport report()
Configuration parameters for the optional job-completion report.
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.
public final JobManifest manifest()
Configuration parameters for the manifest.
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.
public final Integer priority()
The numerical priority for this job. Higher numbers indicate higher priority.
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.
public final boolean hasTags()
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.
public CreateJobRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>
toBuilder
in class S3ControlRequest
public static CreateJobRequest.Builder builder()
public static Class<? extends CreateJobRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.