S3JobDefinition (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.macie2.model.S3JobDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<S3JobDefinition.Builder,S3JobDefinition>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class S3JobDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<S3JobDefinition.Builder,S3JobDefinition>
```
Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis. The bucket specification can be static (bucketDefinitions) or dynamic (bucketCriteria). If it's static, the job analyzes objects in the same predefined set of buckets each time the job runs. If it's dynamic, the job analyzes objects in any buckets that match the specified criteria each time the job starts to run.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface S3JobDefinition.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`S3BucketCriteriaForJob`	`bucketCriteria()` The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis.
`List<S3BucketDefinitionForJob>`	`bucketDefinitions()` An array of objects, one for each Amazon Web Services account that owns specific S3 buckets to analyze.
`static S3JobDefinition.Builder`	`builder()`
`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)`
`boolean`	`hasBucketDefinitions()` For responses, this returns true if the service returned a value for the BucketDefinitions property.
`int`	`hashCode()`
`Scoping`	`scoping()` The property- and tag-based conditions that determine which S3 objects to include or exclude from the analysis.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends S3JobDefinition.Builder>`	`serializableBuilderClass()`
`S3JobDefinition.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 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - hasBucketDefinitions
```
public final boolean hasBucketDefinitions()
```
    For responses, this returns true if the service returned a value for the BucketDefinitions 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.
  - bucketDefinitions
```
public final List<S3BucketDefinitionForJob> bucketDefinitions()
```
    An array of objects, one for each Amazon Web Services account that owns specific S3 buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.
    
    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 hasBucketDefinitions() method.
    
    Returns:
    
    An array of objects, one for each Amazon Web Services account that owns specific S3 buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.
  - scoping
```
public final Scoping scoping()
```
    The property- and tag-based conditions that determine which S3 objects to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which objects to analyze.
    
    Returns:
    
    The property- and tag-based conditions that determine which S3 objects to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which objects to analyze.
  - bucketCriteria
```
public final S3BucketCriteriaForJob bucketCriteria()
```
    The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which buckets contain objects to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.
    
    Returns:
    
    The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which buckets contain objects to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.
  - toBuilder
```
public S3JobDefinition.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<S3JobDefinition.Builder,S3JobDefinition>
    
    Returns:
    
    a builder for type T
  - builder
```
public static S3JobDefinition.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends S3JobDefinition.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - 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.

AWS SDK for Java API Reference - 2.17.91

Class S3JobDefinition

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasBucketDefinitions

bucketDefinitions

scoping

bucketCriteria

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields