com.amazonaws.services.snowball.model.UpdateJobRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-snowball Show documentation
/*
* Copyright 2019-2024 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.snowball.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 UpdateJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.
*
*/
private String jobId;
/**
*
* The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the
* CreateRoleIdentity and
* Access Management (IAM) API action.
*
*/
private String roleARN;
/**
*
* The new or updated Notification object.
*
*/
private Notification notification;
/**
*
* The updated JobResource object, or the updated JobResource object.
*
*/
private JobResource resources;
/**
*
* Specifies the service or services on the Snow Family device that your transferred data will be exported from or
* imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon
* Web Services Storage Gateway service Tape Gateway type.
*
*/
private OnDeviceServiceConfiguration onDeviceServiceConfiguration;
/**
*
* The ID of the updated Address object.
*
*/
private String addressId;
/**
*
* The updated shipping option value of this job's ShippingDetails object.
*
*/
private String shippingOption;
/**
*
* The updated description of this job's JobMetadata object.
*
*/
private String description;
/**
*
* The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs
* are only available in the US regions.
*
*
* For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html"
* (Snow Family Devices and Capacity) in the Snowcone User Guide or
* "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and
* Capacity) in the Snowcone User Guide.
*
*/
private String snowballCapacityPreference;
/**
*
* The updated ID for the forwarding address for a job. This field is not supported in most regions.
*
*/
private String forwardingAddressId;
private PickupDetails pickupDetails;
/**
*
* The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.
*
*
* @param jobId
* The job ID of the job that you want to update, for example
* JID123e4567-e89b-12d3-a456-426655440000.
*/
public void setJobId(String jobId) {
this.jobId = jobId;
}
/**
*
* The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.
*
*
* @return The job ID of the job that you want to update, for example
* JID123e4567-e89b-12d3-a456-426655440000.
*/
public String getJobId() {
return this.jobId;
}
/**
*
* The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.
*
*
* @param jobId
* The job ID of the job that you want to update, for example
* JID123e4567-e89b-12d3-a456-426655440000.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateJobRequest withJobId(String jobId) {
setJobId(jobId);
return this;
}
/**
*
* The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the
* CreateRoleIdentity and
* Access Management (IAM) API action.
*
*
* @param roleARN
* The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN,
* use the CreateRoleIdentity and
* Access Management (IAM) API action.
*/
public void setRoleARN(String roleARN) {
this.roleARN = roleARN;
}
/**
*
* The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the
* CreateRoleIdentity and
* Access Management (IAM) API action.
*
*
* @return The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN,
* use the CreateRoleIdentity and
* Access Management (IAM) API action.
*/
public String getRoleARN() {
return this.roleARN;
}
/**
*
* The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the
* CreateRoleIdentity and
* Access Management (IAM) API action.
*
*
* @param roleARN
* The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN,
* use the CreateRoleIdentity and
* Access Management (IAM) API action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateJobRequest withRoleARN(String roleARN) {
setRoleARN(roleARN);
return this;
}
/**
*
* The new or updated Notification object.
*
*
* @param notification
* The new or updated Notification object.
*/
public void setNotification(Notification notification) {
this.notification = notification;
}
/**
*
* The new or updated Notification object.
*
*
* @return The new or updated Notification object.
*/
public Notification getNotification() {
return this.notification;
}
/**
*
* The new or updated Notification object.
*
*
* @param notification
* The new or updated Notification object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateJobRequest withNotification(Notification notification) {
setNotification(notification);
return this;
}
/**
*
* The updated JobResource object, or the updated JobResource object.
*
*
* @param resources
* The updated JobResource object, or the updated JobResource object.
*/
public void setResources(JobResource resources) {
this.resources = resources;
}
/**
*
* The updated JobResource object, or the updated JobResource object.
*
*
* @return The updated JobResource object, or the updated JobResource object.
*/
public JobResource getResources() {
return this.resources;
}
/**
*
* The updated JobResource object, or the updated JobResource object.
*
*
* @param resources
* The updated JobResource object, or the updated JobResource object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateJobRequest withResources(JobResource resources) {
setResources(resources);
return this;
}
/**
*
* Specifies the service or services on the Snow Family device that your transferred data will be exported from or
* imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon
* Web Services Storage Gateway service Tape Gateway type.
*
*
* @param onDeviceServiceConfiguration
* Specifies the service or services on the Snow Family device that your transferred data will be exported
* from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System)
* and the Amazon Web Services Storage Gateway service Tape Gateway type.
*/
public void setOnDeviceServiceConfiguration(OnDeviceServiceConfiguration onDeviceServiceConfiguration) {
this.onDeviceServiceConfiguration = onDeviceServiceConfiguration;
}
/**
*
* Specifies the service or services on the Snow Family device that your transferred data will be exported from or
* imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon
* Web Services Storage Gateway service Tape Gateway type.
*
*
* @return Specifies the service or services on the Snow Family device that your transferred data will be exported
* from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System)
* and the Amazon Web Services Storage Gateway service Tape Gateway type.
*/
public OnDeviceServiceConfiguration getOnDeviceServiceConfiguration() {
return this.onDeviceServiceConfiguration;
}
/**
*
* Specifies the service or services on the Snow Family device that your transferred data will be exported from or
* imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon
* Web Services Storage Gateway service Tape Gateway type.
*
*
* @param onDeviceServiceConfiguration
* Specifies the service or services on the Snow Family device that your transferred data will be exported
* from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System)
* and the Amazon Web Services Storage Gateway service Tape Gateway type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateJobRequest withOnDeviceServiceConfiguration(OnDeviceServiceConfiguration onDeviceServiceConfiguration) {
setOnDeviceServiceConfiguration(onDeviceServiceConfiguration);
return this;
}
/**
*
* The ID of the updated Address object.
*
*
* @param addressId
* The ID of the updated Address object.
*/
public void setAddressId(String addressId) {
this.addressId = addressId;
}
/**
*
* The ID of the updated Address object.
*
*
* @return The ID of the updated Address object.
*/
public String getAddressId() {
return this.addressId;
}
/**
*
* The ID of the updated Address object.
*
*
* @param addressId
* The ID of the updated Address object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateJobRequest withAddressId(String addressId) {
setAddressId(addressId);
return this;
}
/**
*
* The updated shipping option value of this job's ShippingDetails object.
*
*
* @param shippingOption
* The updated shipping option value of this job's ShippingDetails object.
* @see ShippingOption
*/
public void setShippingOption(String shippingOption) {
this.shippingOption = shippingOption;
}
/**
*
* The updated shipping option value of this job's ShippingDetails object.
*
*
* @return The updated shipping option value of this job's ShippingDetails object.
* @see ShippingOption
*/
public String getShippingOption() {
return this.shippingOption;
}
/**
*
* The updated shipping option value of this job's ShippingDetails object.
*
*
* @param shippingOption
* The updated shipping option value of this job's ShippingDetails object.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ShippingOption
*/
public UpdateJobRequest withShippingOption(String shippingOption) {
setShippingOption(shippingOption);
return this;
}
/**
*
* The updated shipping option value of this job's ShippingDetails object.
*
*
* @param shippingOption
* The updated shipping option value of this job's ShippingDetails object.
* @see ShippingOption
*/
public void setShippingOption(ShippingOption shippingOption) {
withShippingOption(shippingOption);
}
/**
*
* The updated shipping option value of this job's ShippingDetails object.
*
*
* @param shippingOption
* The updated shipping option value of this job's ShippingDetails object.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ShippingOption
*/
public UpdateJobRequest withShippingOption(ShippingOption shippingOption) {
this.shippingOption = shippingOption.toString();
return this;
}
/**
*
* The updated description of this job's JobMetadata object.
*
*
* @param description
* The updated description of this job's JobMetadata object.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The updated description of this job's JobMetadata object.
*
*
* @return The updated description of this job's JobMetadata object.
*/
public String getDescription() {
return this.description;
}
/**
*
* The updated description of this job's JobMetadata object.
*
*
* @param description
* The updated description of this job's JobMetadata object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateJobRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs
* are only available in the US regions.
*
*
* For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html"
* (Snow Family Devices and Capacity) in the Snowcone User Guide or
* "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and
* Capacity) in the Snowcone User Guide.
*
*
* @param snowballCapacityPreference
* The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB
* Snowballs are only available in the US regions.
*
* For more information, see
* "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices
* and Capacity) in the Snowcone User Guide or
* "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices
* and Capacity) in the Snowcone User Guide.
* @see SnowballCapacity
*/
public void setSnowballCapacityPreference(String snowballCapacityPreference) {
this.snowballCapacityPreference = snowballCapacityPreference;
}
/**
*
* The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs
* are only available in the US regions.
*
*
* For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html"
* (Snow Family Devices and Capacity) in the Snowcone User Guide or
* "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and
* Capacity) in the Snowcone User Guide.
*
*
* @return The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB
* Snowballs are only available in the US regions.
*
* For more information, see
* "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices
* and Capacity) in the Snowcone User Guide or
* "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices
* and Capacity) in the Snowcone User Guide.
* @see SnowballCapacity
*/
public String getSnowballCapacityPreference() {
return this.snowballCapacityPreference;
}
/**
*
* The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs
* are only available in the US regions.
*
*
* For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html"
* (Snow Family Devices and Capacity) in the Snowcone User Guide or
* "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and
* Capacity) in the Snowcone User Guide.
*
*
* @param snowballCapacityPreference
* The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB
* Snowballs are only available in the US regions.
*
* For more information, see
* "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices
* and Capacity) in the Snowcone User Guide or
* "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices
* and Capacity) in the Snowcone User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SnowballCapacity
*/
public UpdateJobRequest withSnowballCapacityPreference(String snowballCapacityPreference) {
setSnowballCapacityPreference(snowballCapacityPreference);
return this;
}
/**
*
* The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs
* are only available in the US regions.
*
*
* For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html"
* (Snow Family Devices and Capacity) in the Snowcone User Guide or
* "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and
* Capacity) in the Snowcone User Guide.
*
*
* @param snowballCapacityPreference
* The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB
* Snowballs are only available in the US regions.
*
* For more information, see
* "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices
* and Capacity) in the Snowcone User Guide or
* "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices
* and Capacity) in the Snowcone User Guide.
* @see SnowballCapacity
*/
public void setSnowballCapacityPreference(SnowballCapacity snowballCapacityPreference) {
withSnowballCapacityPreference(snowballCapacityPreference);
}
/**
*
* The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs
* are only available in the US regions.
*
*
* For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html"
* (Snow Family Devices and Capacity) in the Snowcone User Guide or
* "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and
* Capacity) in the Snowcone User Guide.
*
*
* @param snowballCapacityPreference
* The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB
* Snowballs are only available in the US regions.
*
* For more information, see
* "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices
* and Capacity) in the Snowcone User Guide or
* "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices
* and Capacity) in the Snowcone User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SnowballCapacity
*/
public UpdateJobRequest withSnowballCapacityPreference(SnowballCapacity snowballCapacityPreference) {
this.snowballCapacityPreference = snowballCapacityPreference.toString();
return this;
}
/**
*
* The updated ID for the forwarding address for a job. This field is not supported in most regions.
*
*
* @param forwardingAddressId
* The updated ID for the forwarding address for a job. This field is not supported in most regions.
*/
public void setForwardingAddressId(String forwardingAddressId) {
this.forwardingAddressId = forwardingAddressId;
}
/**
*
* The updated ID for the forwarding address for a job. This field is not supported in most regions.
*
*
* @return The updated ID for the forwarding address for a job. This field is not supported in most regions.
*/
public String getForwardingAddressId() {
return this.forwardingAddressId;
}
/**
*
* The updated ID for the forwarding address for a job. This field is not supported in most regions.
*
*
* @param forwardingAddressId
* The updated ID for the forwarding address for a job. This field is not supported in most regions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateJobRequest withForwardingAddressId(String forwardingAddressId) {
setForwardingAddressId(forwardingAddressId);
return this;
}
/**
* @param pickupDetails
*/
public void setPickupDetails(PickupDetails pickupDetails) {
this.pickupDetails = pickupDetails;
}
/**
* @return
*/
public PickupDetails getPickupDetails() {
return this.pickupDetails;
}
/**
* @param pickupDetails
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateJobRequest withPickupDetails(PickupDetails pickupDetails) {
setPickupDetails(pickupDetails);
return this;
}
/**
* 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 (getJobId() != null)
sb.append("JobId: ").append(getJobId()).append(",");
if (getRoleARN() != null)
sb.append("RoleARN: ").append(getRoleARN()).append(",");
if (getNotification() != null)
sb.append("Notification: ").append(getNotification()).append(",");
if (getResources() != null)
sb.append("Resources: ").append(getResources()).append(",");
if (getOnDeviceServiceConfiguration() != null)
sb.append("OnDeviceServiceConfiguration: ").append(getOnDeviceServiceConfiguration()).append(",");
if (getAddressId() != null)
sb.append("AddressId: ").append(getAddressId()).append(",");
if (getShippingOption() != null)
sb.append("ShippingOption: ").append(getShippingOption()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getSnowballCapacityPreference() != null)
sb.append("SnowballCapacityPreference: ").append(getSnowballCapacityPreference()).append(",");
if (getForwardingAddressId() != null)
sb.append("ForwardingAddressId: ").append(getForwardingAddressId()).append(",");
if (getPickupDetails() != null)
sb.append("PickupDetails: ").append(getPickupDetails());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateJobRequest == false)
return false;
UpdateJobRequest other = (UpdateJobRequest) obj;
if (other.getJobId() == null ^ this.getJobId() == null)
return false;
if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false)
return false;
if (other.getRoleARN() == null ^ this.getRoleARN() == null)
return false;
if (other.getRoleARN() != null && other.getRoleARN().equals(this.getRoleARN()) == false)
return false;
if (other.getNotification() == null ^ this.getNotification() == null)
return false;
if (other.getNotification() != null && other.getNotification().equals(this.getNotification()) == false)
return false;
if (other.getResources() == null ^ this.getResources() == null)
return false;
if (other.getResources() != null && other.getResources().equals(this.getResources()) == false)
return false;
if (other.getOnDeviceServiceConfiguration() == null ^ this.getOnDeviceServiceConfiguration() == null)
return false;
if (other.getOnDeviceServiceConfiguration() != null && other.getOnDeviceServiceConfiguration().equals(this.getOnDeviceServiceConfiguration()) == false)
return false;
if (other.getAddressId() == null ^ this.getAddressId() == null)
return false;
if (other.getAddressId() != null && other.getAddressId().equals(this.getAddressId()) == false)
return false;
if (other.getShippingOption() == null ^ this.getShippingOption() == null)
return false;
if (other.getShippingOption() != null && other.getShippingOption().equals(this.getShippingOption()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getSnowballCapacityPreference() == null ^ this.getSnowballCapacityPreference() == null)
return false;
if (other.getSnowballCapacityPreference() != null && other.getSnowballCapacityPreference().equals(this.getSnowballCapacityPreference()) == false)
return false;
if (other.getForwardingAddressId() == null ^ this.getForwardingAddressId() == null)
return false;
if (other.getForwardingAddressId() != null && other.getForwardingAddressId().equals(this.getForwardingAddressId()) == false)
return false;
if (other.getPickupDetails() == null ^ this.getPickupDetails() == null)
return false;
if (other.getPickupDetails() != null && other.getPickupDetails().equals(this.getPickupDetails()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode());
hashCode = prime * hashCode + ((getRoleARN() == null) ? 0 : getRoleARN().hashCode());
hashCode = prime * hashCode + ((getNotification() == null) ? 0 : getNotification().hashCode());
hashCode = prime * hashCode + ((getResources() == null) ? 0 : getResources().hashCode());
hashCode = prime * hashCode + ((getOnDeviceServiceConfiguration() == null) ? 0 : getOnDeviceServiceConfiguration().hashCode());
hashCode = prime * hashCode + ((getAddressId() == null) ? 0 : getAddressId().hashCode());
hashCode = prime * hashCode + ((getShippingOption() == null) ? 0 : getShippingOption().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getSnowballCapacityPreference() == null) ? 0 : getSnowballCapacityPreference().hashCode());
hashCode = prime * hashCode + ((getForwardingAddressId() == null) ? 0 : getForwardingAddressId().hashCode());
hashCode = prime * hashCode + ((getPickupDetails() == null) ? 0 : getPickupDetails().hashCode());
return hashCode;
}
@Override
public UpdateJobRequest clone() {
return (UpdateJobRequest) super.clone();
}
}