com.amazonaws.services.servicecatalog.model.CreateServiceActionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-servicecatalog 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.servicecatalog.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 CreateServiceActionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The self-service action name.
*
*/
private String name;
/**
*
* The service action definition type. For example, SSM_AUTOMATION.
*
*/
private String definitionType;
/**
*
* The self-service action definition. Can be one of the following:
*
*
* - Name
* -
*
* The name of the Amazon Web Services Systems Manager document (SSM document). For example,
* AWS-RestartEC2Instance.
*
*
* If you are using a shared SSM document, you must provide the ARN instead of the name.
*
*
* - Version
* -
*
* The Amazon Web Services Systems Manager automation document version. For example, "Version": "1"
*
*
* - AssumeRole
* -
*
* The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example,
* "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".
*
*
* To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".
*
*
* - Parameters
* -
*
* The list of parameters in JSON format.
*
*
* For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or
* [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].
*
*
*
*/
private java.util.Map definition;
/**
*
* The self-service action description.
*
*/
private String description;
/**
*
* The language code.
*
*
* -
*
* jp - Japanese
*
*
* -
*
* zh - Chinese
*
*
*
*/
private String acceptLanguage;
/**
*
* A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency
* token, the same response is returned for each repeated request.
*
*/
private String idempotencyToken;
/**
*
* The self-service action name.
*
*
* @param name
* The self-service action name.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The self-service action name.
*
*
* @return The self-service action name.
*/
public String getName() {
return this.name;
}
/**
*
* The self-service action name.
*
*
* @param name
* The self-service action name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceActionRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The service action definition type. For example, SSM_AUTOMATION.
*
*
* @param definitionType
* The service action definition type. For example, SSM_AUTOMATION.
* @see ServiceActionDefinitionType
*/
public void setDefinitionType(String definitionType) {
this.definitionType = definitionType;
}
/**
*
* The service action definition type. For example, SSM_AUTOMATION.
*
*
* @return The service action definition type. For example, SSM_AUTOMATION.
* @see ServiceActionDefinitionType
*/
public String getDefinitionType() {
return this.definitionType;
}
/**
*
* The service action definition type. For example, SSM_AUTOMATION.
*
*
* @param definitionType
* The service action definition type. For example, SSM_AUTOMATION.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServiceActionDefinitionType
*/
public CreateServiceActionRequest withDefinitionType(String definitionType) {
setDefinitionType(definitionType);
return this;
}
/**
*
* The service action definition type. For example, SSM_AUTOMATION.
*
*
* @param definitionType
* The service action definition type. For example, SSM_AUTOMATION.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServiceActionDefinitionType
*/
public CreateServiceActionRequest withDefinitionType(ServiceActionDefinitionType definitionType) {
this.definitionType = definitionType.toString();
return this;
}
/**
*
* The self-service action definition. Can be one of the following:
*
*
* - Name
* -
*
* The name of the Amazon Web Services Systems Manager document (SSM document). For example,
* AWS-RestartEC2Instance.
*
*
* If you are using a shared SSM document, you must provide the ARN instead of the name.
*
*
* - Version
* -
*
* The Amazon Web Services Systems Manager automation document version. For example, "Version": "1"
*
*
* - AssumeRole
* -
*
* The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example,
* "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".
*
*
* To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".
*
*
* - Parameters
* -
*
* The list of parameters in JSON format.
*
*
* For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or
* [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].
*
*
*
*
* @return The self-service action definition. Can be one of the following:
*
* - Name
* -
*
* The name of the Amazon Web Services Systems Manager document (SSM document). For example,
* AWS-RestartEC2Instance.
*
*
* If you are using a shared SSM document, you must provide the ARN instead of the name.
*
*
* - Version
* -
*
* The Amazon Web Services Systems Manager automation document version. For example,
* "Version": "1"
*
*
* - AssumeRole
* -
*
* The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For
* example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".
*
*
* To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".
*
*
* - Parameters
* -
*
* The list of parameters in JSON format.
*
*
* For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or
* [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].
*
*
*/
public java.util.Map getDefinition() {
return definition;
}
/**
*
* The self-service action definition. Can be one of the following:
*
*
* - Name
* -
*
* The name of the Amazon Web Services Systems Manager document (SSM document). For example,
* AWS-RestartEC2Instance.
*
*
* If you are using a shared SSM document, you must provide the ARN instead of the name.
*
*
* - Version
* -
*
* The Amazon Web Services Systems Manager automation document version. For example, "Version": "1"
*
*
* - AssumeRole
* -
*
* The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example,
* "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".
*
*
* To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".
*
*
* - Parameters
* -
*
* The list of parameters in JSON format.
*
*
* For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or
* [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].
*
*
*
*
* @param definition
* The self-service action definition. Can be one of the following:
*
* - Name
* -
*
* The name of the Amazon Web Services Systems Manager document (SSM document). For example,
* AWS-RestartEC2Instance.
*
*
* If you are using a shared SSM document, you must provide the ARN instead of the name.
*
*
* - Version
* -
*
* The Amazon Web Services Systems Manager automation document version. For example,
* "Version": "1"
*
*
* - AssumeRole
* -
*
* The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For
* example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".
*
*
* To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".
*
*
* - Parameters
* -
*
* The list of parameters in JSON format.
*
*
* For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or
* [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].
*
*
*/
public void setDefinition(java.util.Map definition) {
this.definition = definition;
}
/**
*
* The self-service action definition. Can be one of the following:
*
*
* - Name
* -
*
* The name of the Amazon Web Services Systems Manager document (SSM document). For example,
* AWS-RestartEC2Instance.
*
*
* If you are using a shared SSM document, you must provide the ARN instead of the name.
*
*
* - Version
* -
*
* The Amazon Web Services Systems Manager automation document version. For example, "Version": "1"
*
*
* - AssumeRole
* -
*
* The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example,
* "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".
*
*
* To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".
*
*
* - Parameters
* -
*
* The list of parameters in JSON format.
*
*
* For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or
* [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].
*
*
*
*
* @param definition
* The self-service action definition. Can be one of the following:
*
* - Name
* -
*
* The name of the Amazon Web Services Systems Manager document (SSM document). For example,
* AWS-RestartEC2Instance.
*
*
* If you are using a shared SSM document, you must provide the ARN instead of the name.
*
*
* - Version
* -
*
* The Amazon Web Services Systems Manager automation document version. For example,
* "Version": "1"
*
*
* - AssumeRole
* -
*
* The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For
* example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".
*
*
* To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".
*
*
* - Parameters
* -
*
* The list of parameters in JSON format.
*
*
* For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or
* [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceActionRequest withDefinition(java.util.Map definition) {
setDefinition(definition);
return this;
}
/**
* Add a single Definition entry
*
* @see CreateServiceActionRequest#withDefinition
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceActionRequest addDefinitionEntry(String key, String value) {
if (null == this.definition) {
this.definition = new java.util.HashMap();
}
if (this.definition.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.definition.put(key, value);
return this;
}
/**
* Removes all the entries added into Definition.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceActionRequest clearDefinitionEntries() {
this.definition = null;
return this;
}
/**
*
* The self-service action description.
*
*
* @param description
* The self-service action description.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The self-service action description.
*
*
* @return The self-service action description.
*/
public String getDescription() {
return this.description;
}
/**
*
* The self-service action description.
*
*
* @param description
* The self-service action description.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceActionRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The language code.
*
*
* -
*
* jp - Japanese
*
*
* -
*
* zh - Chinese
*
*
*
*
* @param acceptLanguage
* The language code.
*
* -
*
* jp - Japanese
*
*
* -
*
* zh - Chinese
*
*
*/
public void setAcceptLanguage(String acceptLanguage) {
this.acceptLanguage = acceptLanguage;
}
/**
*
* The language code.
*
*
* -
*
* jp - Japanese
*
*
* -
*
* zh - Chinese
*
*
*
*
* @return The language code.
*
* -
*
* jp - Japanese
*
*
* -
*
* zh - Chinese
*
*
*/
public String getAcceptLanguage() {
return this.acceptLanguage;
}
/**
*
* The language code.
*
*
* -
*
* jp - Japanese
*
*
* -
*
* zh - Chinese
*
*
*
*
* @param acceptLanguage
* The language code.
*
* -
*
* jp - Japanese
*
*
* -
*
* zh - Chinese
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceActionRequest withAcceptLanguage(String acceptLanguage) {
setAcceptLanguage(acceptLanguage);
return this;
}
/**
*
* A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency
* token, the same response is returned for each repeated request.
*
*
* @param idempotencyToken
* A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the
* idempotency token, the same response is returned for each repeated request.
*/
public void setIdempotencyToken(String idempotencyToken) {
this.idempotencyToken = idempotencyToken;
}
/**
*
* A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency
* token, the same response is returned for each repeated request.
*
*
* @return A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the
* idempotency token, the same response is returned for each repeated request.
*/
public String getIdempotencyToken() {
return this.idempotencyToken;
}
/**
*
* A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency
* token, the same response is returned for each repeated request.
*
*
* @param idempotencyToken
* A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the
* idempotency token, the same response is returned for each repeated request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateServiceActionRequest withIdempotencyToken(String idempotencyToken) {
setIdempotencyToken(idempotencyToken);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDefinitionType() != null)
sb.append("DefinitionType: ").append(getDefinitionType()).append(",");
if (getDefinition() != null)
sb.append("Definition: ").append(getDefinition()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getAcceptLanguage() != null)
sb.append("AcceptLanguage: ").append(getAcceptLanguage()).append(",");
if (getIdempotencyToken() != null)
sb.append("IdempotencyToken: ").append(getIdempotencyToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateServiceActionRequest == false)
return false;
CreateServiceActionRequest other = (CreateServiceActionRequest) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDefinitionType() == null ^ this.getDefinitionType() == null)
return false;
if (other.getDefinitionType() != null && other.getDefinitionType().equals(this.getDefinitionType()) == false)
return false;
if (other.getDefinition() == null ^ this.getDefinition() == null)
return false;
if (other.getDefinition() != null && other.getDefinition().equals(this.getDefinition()) == 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.getAcceptLanguage() == null ^ this.getAcceptLanguage() == null)
return false;
if (other.getAcceptLanguage() != null && other.getAcceptLanguage().equals(this.getAcceptLanguage()) == false)
return false;
if (other.getIdempotencyToken() == null ^ this.getIdempotencyToken() == null)
return false;
if (other.getIdempotencyToken() != null && other.getIdempotencyToken().equals(this.getIdempotencyToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDefinitionType() == null) ? 0 : getDefinitionType().hashCode());
hashCode = prime * hashCode + ((getDefinition() == null) ? 0 : getDefinition().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getAcceptLanguage() == null) ? 0 : getAcceptLanguage().hashCode());
hashCode = prime * hashCode + ((getIdempotencyToken() == null) ? 0 : getIdempotencyToken().hashCode());
return hashCode;
}
@Override
public CreateServiceActionRequest clone() {
return (CreateServiceActionRequest) super.clone();
}
}