Package software.amazon.awssdk.services.migrationhub.model

Class PutResourceAttributesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.migrationhub.model.MigrationHubRequest

software.amazon.awssdk.services.migrationhub.model.PutResourceAttributesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutResourceAttributesRequest.Builder,PutResourceAttributesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutResourceAttributesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutResourceAttributesRequest.Builder	builder()
Boolean	dryRun()	Optional boolean flag to indicate whether any effect should take place.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResourceAttributeList()	For responses, this returns true if the service returned a value for the ResourceAttributeList property.
String	migrationTaskName()	Unique identifier that references the migration task.
String	progressUpdateStream()	The name of the ProgressUpdateStream.
List<ResourceAttribute>	resourceAttributeList()	Information about the resource that is being migrated.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PutResourceAttributesRequest.Builder>	serializableBuilderClass()
PutResourceAttributesRequest.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

progressUpdateStream

public final String progressUpdateStream()

The name of the ProgressUpdateStream.

Returns:

The name of the ProgressUpdateStream.

migrationTaskName

public final String migrationTaskName()

Unique identifier that references the migration task. Do not store personal data in this field.

Returns:

Unique identifier that references the migration task. Do not store personal data in this field.

hasResourceAttributeList

public final boolean hasResourceAttributeList()

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

resourceAttributeList

public final List<ResourceAttribute> resourceAttributeList()

Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service repository.

Takes the object array of ResourceAttribute where the Type field is reserved for the following values: IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER where the identifying value can be a string up to 256 characters.

• If any "VM" related value is set for a ResourceAttribute object, it is required that VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID is not set, then all "VM" fields will be discarded and "VM" fields will not be used for matching the migration task to a server in Application Discovery Service repository. See the Example section below for a use case of specifying "VM" related values.

• If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the ResourceAttributeList parameter to maximize the chances of matching.

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

Returns:

Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service repository.

Takes the object array of ResourceAttribute where the Type field is reserved for the following values: IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER where the identifying value can be a string up to 256 characters.

• If any "VM" related value is set for a ResourceAttribute object, it is required that VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID is not set, then all "VM" fields will be discarded and "VM" fields will not be used for matching the migration task to a server in Application Discovery Service repository. See the Example section below for a use case of specifying "VM" related values.

• If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the ResourceAttributeList parameter to maximize the chances of matching.

dryRun

public final Boolean dryRun()

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Returns:

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

toBuilder

public PutResourceAttributesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutResourceAttributesRequest.Builder,PutResourceAttributesRequest>

Specified by:

toBuilder in class MigrationHubRequest

builder

public static PutResourceAttributesRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo