com.amazonaws.services.cloudformation.model.ModuleInfo Maven / Gradle / Ivy
/*
* Copyright 2017-2022 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.cloudformation.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Contains information about the module from which the resource was created, if the resource was created from a module
* included in the stack template.
*
*
* For more information about modules, see Using modules to
* encapsulate and reuse resource configurations in the CloudFormation User Guide.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ModuleInfo implements Serializable, Cloneable {
/**
*
* A concatenated list of the module type or types containing the resource. Module types are listed starting with
* the inner-most nested module, and separated by /.
*
*
* In the following example, the resource was created from a module of type AWS::First::Example::MODULE
* , that's nested inside a parent module of type AWS::Second::Example::MODULE.
*
*
* AWS::First::Example::MODULE/AWS::Second::Example::MODULE
*
*/
private String typeHierarchy;
/**
*
* A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed
* starting with the inner-most nested module, and separated by /.
*
*
* In the following example, the resource was created from a module, moduleA, that's nested inside a
* parent module, moduleB.
*
*
* moduleA/moduleB
*
*
* For more information, see Referencing resources in a module
* in the CloudFormation User Guide.
*
*/
private String logicalIdHierarchy;
/**
*
* A concatenated list of the module type or types containing the resource. Module types are listed starting with
* the inner-most nested module, and separated by /.
*
*
* In the following example, the resource was created from a module of type AWS::First::Example::MODULE
* , that's nested inside a parent module of type AWS::Second::Example::MODULE.
*
*
* AWS::First::Example::MODULE/AWS::Second::Example::MODULE
*
*
* @param typeHierarchy
* A concatenated list of the module type or types containing the resource. Module types are listed starting
* with the inner-most nested module, and separated by /.
*
* In the following example, the resource was created from a module of type
* AWS::First::Example::MODULE, that's nested inside a parent module of type
* AWS::Second::Example::MODULE.
*
*
* AWS::First::Example::MODULE/AWS::Second::Example::MODULE
*/
public void setTypeHierarchy(String typeHierarchy) {
this.typeHierarchy = typeHierarchy;
}
/**
*
* A concatenated list of the module type or types containing the resource. Module types are listed starting with
* the inner-most nested module, and separated by /.
*
*
* In the following example, the resource was created from a module of type AWS::First::Example::MODULE
* , that's nested inside a parent module of type AWS::Second::Example::MODULE.
*
*
* AWS::First::Example::MODULE/AWS::Second::Example::MODULE
*
*
* @return A concatenated list of the module type or types containing the resource. Module types are listed starting
* with the inner-most nested module, and separated by /.
*
* In the following example, the resource was created from a module of type
* AWS::First::Example::MODULE, that's nested inside a parent module of type
* AWS::Second::Example::MODULE.
*
*
* AWS::First::Example::MODULE/AWS::Second::Example::MODULE
*/
public String getTypeHierarchy() {
return this.typeHierarchy;
}
/**
*
* A concatenated list of the module type or types containing the resource. Module types are listed starting with
* the inner-most nested module, and separated by /.
*
*
* In the following example, the resource was created from a module of type AWS::First::Example::MODULE
* , that's nested inside a parent module of type AWS::Second::Example::MODULE.
*
*
* AWS::First::Example::MODULE/AWS::Second::Example::MODULE
*
*
* @param typeHierarchy
* A concatenated list of the module type or types containing the resource. Module types are listed starting
* with the inner-most nested module, and separated by /.
*
* In the following example, the resource was created from a module of type
* AWS::First::Example::MODULE, that's nested inside a parent module of type
* AWS::Second::Example::MODULE.
*
*
* AWS::First::Example::MODULE/AWS::Second::Example::MODULE
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModuleInfo withTypeHierarchy(String typeHierarchy) {
setTypeHierarchy(typeHierarchy);
return this;
}
/**
*
* A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed
* starting with the inner-most nested module, and separated by /.
*
*
* In the following example, the resource was created from a module, moduleA, that's nested inside a
* parent module, moduleB.
*
*
* moduleA/moduleB
*
*
* For more information, see Referencing resources in a module
* in the CloudFormation User Guide.
*
*
* @param logicalIdHierarchy
* A concatenated list of the logical IDs of the module or modules containing the resource. Modules are
* listed starting with the inner-most nested module, and separated by /.
*
* In the following example, the resource was created from a module, moduleA, that's nested
* inside a parent module, moduleB.
*
*
* moduleA/moduleB
*
*
* For more information, see Referencing resources in a
* module in the CloudFormation User Guide.
*/
public void setLogicalIdHierarchy(String logicalIdHierarchy) {
this.logicalIdHierarchy = logicalIdHierarchy;
}
/**
*
* A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed
* starting with the inner-most nested module, and separated by /.
*
*
* In the following example, the resource was created from a module, moduleA, that's nested inside a
* parent module, moduleB.
*
*
* moduleA/moduleB
*
*
* For more information, see Referencing resources in a module
* in the CloudFormation User Guide.
*
*
* @return A concatenated list of the logical IDs of the module or modules containing the resource. Modules are
* listed starting with the inner-most nested module, and separated by /.
*
* In the following example, the resource was created from a module, moduleA, that's nested
* inside a parent module, moduleB.
*
*
* moduleA/moduleB
*
*
* For more information, see Referencing resources in a
* module in the CloudFormation User Guide.
*/
public String getLogicalIdHierarchy() {
return this.logicalIdHierarchy;
}
/**
*
* A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed
* starting with the inner-most nested module, and separated by /.
*
*
* In the following example, the resource was created from a module, moduleA, that's nested inside a
* parent module, moduleB.
*
*
* moduleA/moduleB
*
*
* For more information, see Referencing resources in a module
* in the CloudFormation User Guide.
*
*
* @param logicalIdHierarchy
* A concatenated list of the logical IDs of the module or modules containing the resource. Modules are
* listed starting with the inner-most nested module, and separated by /.
*
* In the following example, the resource was created from a module, moduleA, that's nested
* inside a parent module, moduleB.
*
*
* moduleA/moduleB
*
*
* For more information, see Referencing resources in a
* module in the CloudFormation User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModuleInfo withLogicalIdHierarchy(String logicalIdHierarchy) {
setLogicalIdHierarchy(logicalIdHierarchy);
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 (getTypeHierarchy() != null)
sb.append("TypeHierarchy: ").append(getTypeHierarchy()).append(",");
if (getLogicalIdHierarchy() != null)
sb.append("LogicalIdHierarchy: ").append(getLogicalIdHierarchy());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ModuleInfo == false)
return false;
ModuleInfo other = (ModuleInfo) obj;
if (other.getTypeHierarchy() == null ^ this.getTypeHierarchy() == null)
return false;
if (other.getTypeHierarchy() != null && other.getTypeHierarchy().equals(this.getTypeHierarchy()) == false)
return false;
if (other.getLogicalIdHierarchy() == null ^ this.getLogicalIdHierarchy() == null)
return false;
if (other.getLogicalIdHierarchy() != null && other.getLogicalIdHierarchy().equals(this.getLogicalIdHierarchy()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTypeHierarchy() == null) ? 0 : getTypeHierarchy().hashCode());
hashCode = prime * hashCode + ((getLogicalIdHierarchy() == null) ? 0 : getLogicalIdHierarchy().hashCode());
return hashCode;
}
@Override
public ModuleInfo clone() {
try {
return (ModuleInfo) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}