Package software.amazon.awssdk.services.deadline.model

Class BatchGetJobEntityRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.deadline.model.DeadlineRequest

software.amazon.awssdk.services.deadline.model.BatchGetJobEntityRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchGetJobEntityRequest.Builder,BatchGetJobEntityRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchGetJobEntityRequest.Builder

Method Summary

Modifier and Type	Method	Description
static BatchGetJobEntityRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	farmId()	The farm ID of the worker that's fetching job details.
String	fleetId()	The fleet ID of the worker that's fetching job details.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIdentifiers()	For responses, this returns true if the service returned a value for the Identifiers property.
List<JobEntityIdentifiersUnion>	identifiers()	The job identifiers to include within the job entity batch details.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchGetJobEntityRequest.Builder>	serializableBuilderClass()
BatchGetJobEntityRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workerId()	The worker ID of the worker containing the job details to get.

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

farmId

public final String farmId()

The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.

Returns:

The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.

fleetId

public final String fleetId()

The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.

Returns:

The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.

hasIdentifiers

public final boolean hasIdentifiers()

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

identifiers

public final List<JobEntityIdentifiersUnion> identifiers()

The job identifiers to include within the job entity batch details.

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

Returns:

The job identifiers to include within the job entity batch details.

workerId

public final String workerId()

The worker ID of the worker containing the job details to get.

Returns:

The worker ID of the worker containing the job details to get.

toBuilder

public BatchGetJobEntityRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchGetJobEntityRequest.Builder,BatchGetJobEntityRequest>

Specified by:

toBuilder in class DeadlineRequest

builder

public static BatchGetJobEntityRequest.Builder builder()

serializableBuilderClass

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