CreateJobRequest (AWS Java SDK :: Services :: Amazon S3 Control 2.20.103 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateJobRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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.
`JobManifestGenerator`	`manifestGenerator()` The attribute container for the ManifestGenerator details.
`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()`
`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
clone, finalize, 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 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>
    
    Specified by:
    
    toBuilder in class S3ControlRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateJobRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

accountId

confirmationRequired

operation

report

clientRequestToken

manifest

description

priority

roleArn

hasTags

tags

manifestGenerator

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields