Class CreateJobRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateJobRequest.Builder,
CreateJobRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Amazon Web Services account ID that creates the job.static CreateJobRequest.Builder
builder()
final String
An idempotency token to ensure that you don't accidentally submit the same request twice.final Boolean
Indicates whether confirmation is required before Amazon S3 runs the job.final String
A description for this job.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final JobManifest
manifest()
Configuration parameters for the manifest.final JobManifestGenerator
The attribute container for the ManifestGenerator details.final JobOperation
The action that you want this job to perform on every object listed in the manifest.final Integer
priority()
The numerical priority for this job.final JobReport
report()
Configuration parameters for the optional job-completion report.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.static Class
<? extends CreateJobRequest.Builder> tags()
A set of tags to associate with the S3 Batch Operations job.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
accountId
The Amazon Web Services account ID that creates the job.
- Returns:
- The Amazon Web Services account ID that creates the job.
-
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
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
Configuration parameters for the optional job-completion report.
- Returns:
- Configuration parameters for the optional job-completion report.
-
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
Configuration parameters for the manifest.
- Returns:
- Configuration parameters for the manifest.
-
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
The numerical priority for this job. Higher numbers indicate higher priority.
- Returns:
- The numerical priority for this job. Higher numbers indicate higher priority.
-
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 theisEmpty()
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
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
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
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 interfaceToCopyableBuilder<CreateJobRequest.Builder,
CreateJobRequest> - Specified by:
toBuilder
in classS3ControlRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-