Package software.amazon.awssdk.services.m2.model

Class StartBatchJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.m2.model.M2Request

software.amazon.awssdk.services.m2.model.StartBatchJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartBatchJobRequest.Builder,StartBatchJobRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartBatchJobRequest
extends M2Request
implements ToCopyableBuilder<StartBatchJobRequest.Builder,StartBatchJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartBatchJobRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The unique identifier of the application associated with this batch job.
BatchJobIdentifier	batchJobIdentifier()	The unique identifier of the batch job.
static StartBatchJobRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasJobParams()	For responses, this returns true if the service returned a value for the JobParams property.
Map<String,String>	jobParams()	The collection of batch job parameters.
List<SdkField<?>>	sdkFields()
static Class<? extends StartBatchJobRequest.Builder>	serializableBuilderClass()
StartBatchJobRequest.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

applicationId

public final String applicationId()

The unique identifier of the application associated with this batch job.

Returns:

The unique identifier of the application associated with this batch job.

batchJobIdentifier

public final BatchJobIdentifier batchJobIdentifier()

The unique identifier of the batch job.

Returns:

The unique identifier of the batch job.

hasJobParams

public final boolean hasJobParams()

For responses, this returns true if the service returned a value for the JobParams 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.

jobParams

public final Map<String,String> jobParams()

The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.

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 hasJobParams() method.

Returns:

The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.

toBuilder

public StartBatchJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartBatchJobRequest.Builder,StartBatchJobRequest>

Specified by:

toBuilder in class M2Request

builder

public static StartBatchJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartBatchJobRequest.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