PutResourceAttributesRequest (AWS SDK for Java

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(value="software.amazon.awssdk:codegen")
public final class PutResourceAttributesRequest
extends MigrationHubRequest
implements ToCopyableBuilder<PutResourceAttributesRequest.Builder,PutResourceAttributesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PutResourceAttributesRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PutResourceAttributesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PutResourceAttributesRequest.Builder`	`builder()`
`Boolean`	`dryRun()` Optional boolean flag to indicate whether any effect should take place.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutResourceAttributesRequest.Builder>`	`serializableBuilderClass()`
`PutResourceAttributesRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - progressUpdateStream
```
public String progressUpdateStream()
```
    The name of the ProgressUpdateStream.
    
    Returns:
    
    The name of the ProgressUpdateStream.
  - migrationTaskName
```
public String migrationTaskName()
```
    Unique identifier that references the migration task.
    
    Returns:
    
    Unique identifier that references the migration task.
  - resourceAttributeList
```
public 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 (ADS)'s 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 (ADS)'s 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.
    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 (ADS)'s 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 (ADS)'s 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 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()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutResourceAttributesRequest.Builder,PutResourceAttributesRequest>
    
    Specified by:
    
    toBuilder in class MigrationHubRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static PutResourceAttributesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutResourceAttributesRequest.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()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class PutResourceAttributesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

progressUpdateStream

migrationTaskName

resourceAttributeList

dryRun

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields