@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 Amazon Web Services 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()
For responses, this returns true if the service returned a value for the Tags property.
|
JobManifest |
manifest()
Configuration parameters for the manifest.
|
JobOperation |
operation()
The action 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 Identity and Access Management (IAM) role that Batch Operations will use
to run this job's action 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.
|
overrideConfigurationcopypublic final String accountId()
The Amazon Web Services 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 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.
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 Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.
public final boolean hasTags()
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.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.
public CreateJobRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>toBuilder in class S3ControlRequestpublic static CreateJobRequest.Builder builder()
public static Class<? extends CreateJobRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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 SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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 SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.