Interface PutResourceAttributesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<PutResourceAttributesRequest.Builder,PutResourceAttributesRequest>, MigrationHubRequest.Builder, SdkBuilder<PutResourceAttributesRequest.Builder,PutResourceAttributesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutResourceAttributesRequest
public static interface PutResourceAttributesRequest.Builder extends MigrationHubRequest.Builder, SdkPojo, CopyableBuilder<PutResourceAttributesRequest.Builder,PutResourceAttributesRequest>

  • Method Details

    • progressUpdateStream

      PutResourceAttributesRequest.Builder progressUpdateStream(String progressUpdateStream)

      The name of the ProgressUpdateStream.

      Parameters:
      progressUpdateStream - The name of the ProgressUpdateStream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • migrationTaskName

      PutResourceAttributesRequest.Builder migrationTaskName(String migrationTaskName)

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

      Parameters:
      migrationTaskName - Unique identifier that references the migration task. Do not store personal data in this field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceAttributeList

      PutResourceAttributesRequest.Builder resourceAttributeList(Collection<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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceAttributeList

      PutResourceAttributesRequest.Builder resourceAttributeList(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceAttributeList

      PutResourceAttributesRequest.Builder resourceAttributeList(Consumer<ResourceAttribute.Builder>... 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.

      This is a convenience method that creates an instance of the ResourceAttribute.Builder avoiding the need to create one manually via ResourceAttribute.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceAttributeList(List<ResourceAttribute>).

      Parameters:
      resourceAttributeList - a consumer that will call methods on ResourceAttribute.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dryRun

      PutResourceAttributesRequest.Builder dryRun(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      PutResourceAttributesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutResourceAttributesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.