software.amazon.awssdk.services.datasync.model

Class CreateAgentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datasync.model.DataSyncRequest

software.amazon.awssdk.services.datasync.model.CreateAgentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateAgentRequest
extends DataSyncRequest
implements ToCopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>

CreateAgentRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAgentRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	activationKey() Your agent activation key.
String	agentName() The name you configured for your agent.
static CreateAgentRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAgentRequest.Builder>	serializableBuilderClass()
List<TagListEntry>	tags() The key-value pair that represents the tag you want to associate with the agent.
CreateAgentRequest.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

activationKey

public String activationKey()

Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the AWS DataSync console.

The redirect URL returned in the response provides you the activation key for your agent in the query string parameter activationKey. It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent. For more information, see Activating a Sync Agent in the AWS DataSync User Guide.

Returns:

Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the AWS DataSync console.

The redirect URL returned in the response provides you the activation key for your agent in the query string parameter activationKey. It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent. For more information, see Activating a Sync Agent in the AWS DataSync User Guide.

agentName

public String agentName()

The name you configured for your agent. This value is a text reference that is used to identify the agent in the console.

Returns:

The name you configured for your agent. This value is a text reference that is used to identify the agent in the console.

tags

public List<TagListEntry> tags()

The key-value pair that represents the tag you want to associate with the agent. The value can be an empty string. This value helps you manage, filter, and search for your agents.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The key-value pair that represents the tag you want to associate with the agent. The value can be an empty string. This value helps you manage, filter, and search for your agents.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.

toBuilder

public CreateAgentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>

Specified by:

toBuilder in class DataSyncRequest

builder

public static CreateAgentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateAgentRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo