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>

  • Method Details

    • 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()
      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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.