Package software.amazon.awssdk.services.greengrass.model

Class StartBulkDeploymentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.greengrass.model.GreengrassRequest

software.amazon.awssdk.services.greengrass.model.StartBulkDeploymentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartBulkDeploymentRequest.Builder,StartBulkDeploymentRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartBulkDeploymentRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	amznClientToken()	A client token used to correlate requests and responses.
static StartBulkDeploymentRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionRoleArn()	The ARN of the execution role to associate with the bulk deployment operation.
<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.
String	inputFileUri()	The URI of the input file contained in the S3 bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends StartBulkDeploymentRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	Tag(s) to add to the new resource.
StartBulkDeploymentRequest.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

amznClientToken

public final String amznClientToken()

A client token used to correlate requests and responses.

Returns:

A client token used to correlate requests and responses.

executionRoleArn

public final String executionRoleArn()

The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the ''greengrass:CreateDeployment'' action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file.

Returns:

The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the ''greengrass:CreateDeployment'' action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file.

inputFileUri

public final String inputFileUri()

The URI of the input file contained in the S3 bucket. The execution role must have ''getObject'' permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only ''NewDeployment'' deployment types.

Returns:

The URI of the input file contained in the S3 bucket. The execution role must have ''getObject'' permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only ''NewDeployment'' deployment types.

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 Map<String,String> tags()

Tag(s) to add to the new resource.

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:

Tag(s) to add to the new resource.

toBuilder

public StartBulkDeploymentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartBulkDeploymentRequest.Builder,StartBulkDeploymentRequest>

Specified by:

toBuilder in class GreengrassRequest

builder

public static StartBulkDeploymentRequest.Builder builder()

serializableBuilderClass

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