com.amazonaws.services.migrationhub.model.PutResourceAttributesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-migrationhub Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.migrationhub.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PutResourceAttributesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the ProgressUpdateStream.
*
*/
private String progressUpdateStream;
/**
*
* Unique identifier that references the migration task. Do not store personal data in this field.
*
*/
private String migrationTaskName;
/**
*
* 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.
*
*
*
*
*/
private java.util.List resourceAttributeList;
/**
*
* Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission
* to make the call.
*
*/
private Boolean dryRun;
/**
*
* The name of the ProgressUpdateStream.
*
*
* @param progressUpdateStream
* The name of the ProgressUpdateStream.
*/
public void setProgressUpdateStream(String progressUpdateStream) {
this.progressUpdateStream = progressUpdateStream;
}
/**
*
* The name of the ProgressUpdateStream.
*
*
* @return The name of the ProgressUpdateStream.
*/
public String getProgressUpdateStream() {
return this.progressUpdateStream;
}
/**
*
* The name of the ProgressUpdateStream.
*
*
* @param progressUpdateStream
* The name of the ProgressUpdateStream.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutResourceAttributesRequest withProgressUpdateStream(String progressUpdateStream) {
setProgressUpdateStream(progressUpdateStream);
return this;
}
/**
*
* Unique identifier that references the migration task. Do not store personal data in this field.
*
*
* @param migrationTaskName
* Unique identifier that references the migration task. Do not store personal data in this field.
*/
public void setMigrationTaskName(String migrationTaskName) {
this.migrationTaskName = migrationTaskName;
}
/**
*
* Unique identifier that references the migration task. Do not store personal data in this field.
*
*
* @return Unique identifier that references the migration task. Do not store personal data in this field.
*/
public String getMigrationTaskName() {
return this.migrationTaskName;
}
/**
*
* Unique identifier that references the migration task. Do not store personal data in this field.
*
*
* @param migrationTaskName
* Unique identifier that references the migration task. Do not store personal data in this field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutResourceAttributesRequest withMigrationTaskName(String migrationTaskName) {
setMigrationTaskName(migrationTaskName);
return this;
}
/**
*
* 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.
*
*
*
*
*
* @return 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.
*
*
*
*/
public java.util.List getResourceAttributeList() {
return 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.
*
*
*
*
*
* @param 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.
*
*
*
*/
public void setResourceAttributeList(java.util.Collection resourceAttributeList) {
if (resourceAttributeList == null) {
this.resourceAttributeList = null;
return;
}
this.resourceAttributeList = new java.util.ArrayList(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.
*
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setResourceAttributeList(java.util.Collection)} or
* {@link #withResourceAttributeList(java.util.Collection)} if you want to override the existing values.
*
*
* @param 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.
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutResourceAttributesRequest withResourceAttributeList(ResourceAttribute... resourceAttributeList) {
if (this.resourceAttributeList == null) {
setResourceAttributeList(new java.util.ArrayList(resourceAttributeList.length));
}
for (ResourceAttribute ele : resourceAttributeList) {
this.resourceAttributeList.add(ele);
}
return this;
}
/**
*
* 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.
*
*
*
*
*
* @param 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.
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutResourceAttributesRequest withResourceAttributeList(java.util.Collection resourceAttributeList) {
setResourceAttributeList(resourceAttributeList);
return this;
}
/**
*
* Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission
* to make the call.
*
*
* @param dryRun
* Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has
* permission to make the call.
*/
public void setDryRun(Boolean dryRun) {
this.dryRun = dryRun;
}
/**
*
* Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission
* to make the call.
*
*
* @return Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has
* permission to make the call.
*/
public Boolean getDryRun() {
return this.dryRun;
}
/**
*
* Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission
* to make the call.
*
*
* @param dryRun
* Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has
* permission to make the call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutResourceAttributesRequest withDryRun(Boolean dryRun) {
setDryRun(dryRun);
return this;
}
/**
*
* Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission
* to make the call.
*
*
* @return Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has
* permission to make the call.
*/
public Boolean isDryRun() {
return this.dryRun;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getProgressUpdateStream() != null)
sb.append("ProgressUpdateStream: ").append(getProgressUpdateStream()).append(",");
if (getMigrationTaskName() != null)
sb.append("MigrationTaskName: ").append(getMigrationTaskName()).append(",");
if (getResourceAttributeList() != null)
sb.append("ResourceAttributeList: ").append(getResourceAttributeList()).append(",");
if (getDryRun() != null)
sb.append("DryRun: ").append(getDryRun());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutResourceAttributesRequest == false)
return false;
PutResourceAttributesRequest other = (PutResourceAttributesRequest) obj;
if (other.getProgressUpdateStream() == null ^ this.getProgressUpdateStream() == null)
return false;
if (other.getProgressUpdateStream() != null && other.getProgressUpdateStream().equals(this.getProgressUpdateStream()) == false)
return false;
if (other.getMigrationTaskName() == null ^ this.getMigrationTaskName() == null)
return false;
if (other.getMigrationTaskName() != null && other.getMigrationTaskName().equals(this.getMigrationTaskName()) == false)
return false;
if (other.getResourceAttributeList() == null ^ this.getResourceAttributeList() == null)
return false;
if (other.getResourceAttributeList() != null && other.getResourceAttributeList().equals(this.getResourceAttributeList()) == false)
return false;
if (other.getDryRun() == null ^ this.getDryRun() == null)
return false;
if (other.getDryRun() != null && other.getDryRun().equals(this.getDryRun()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getProgressUpdateStream() == null) ? 0 : getProgressUpdateStream().hashCode());
hashCode = prime * hashCode + ((getMigrationTaskName() == null) ? 0 : getMigrationTaskName().hashCode());
hashCode = prime * hashCode + ((getResourceAttributeList() == null) ? 0 : getResourceAttributeList().hashCode());
hashCode = prime * hashCode + ((getDryRun() == null) ? 0 : getDryRun().hashCode());
return hashCode;
}
@Override
public PutResourceAttributesRequest clone() {
return (PutResourceAttributesRequest) super.clone();
}
}