DocumentIdentifier (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.simplesystemsmanagement.model.DocumentIdentifier

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentIdentifier
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the name of a SSM document.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentIdentifier()

Constructors
Constructor and Description
`DocumentIdentifier()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentIdentifier`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAuthor()` The user in your organization who created the document.
`Date`	`getCreatedDate()` The date the SSM document was created.
`String`	`getDisplayName()` An optional field where you can specify a friendly name for the SSM document.
`String`	`getDocumentFormat()` The document format, either JSON or YAML.
`String`	`getDocumentType()` The document type.
`String`	`getDocumentVersion()` The document version.
`String`	`getName()` The name of the SSM document.
`String`	`getOwner()` The Amazon Web Services user that created the document.
`List<String>`	`getPlatformTypes()` The operating system platform.
`List<DocumentRequires>`	`getRequires()` A list of SSM documents required by a document.
`String`	`getReviewStatus()` The current status of a document review.
`String`	`getSchemaVersion()` The schema version.
`List<Tag>`	`getTags()` The tags, or metadata, that have been applied to the document.
`String`	`getTargetType()` The target type which defines the kinds of resources the document can run on.
`String`	`getVersionName()` An optional field specifying the version of the artifact associated with the document.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAuthor(String author)` The user in your organization who created the document.
`void`	`setCreatedDate(Date createdDate)` The date the SSM document was created.
`void`	`setDisplayName(String displayName)` An optional field where you can specify a friendly name for the SSM document.
`void`	`setDocumentFormat(DocumentFormat documentFormat)` The document format, either JSON or YAML.
`void`	`setDocumentFormat(String documentFormat)` The document format, either JSON or YAML.
`void`	`setDocumentType(DocumentType documentType)` The document type.
`void`	`setDocumentType(String documentType)` The document type.
`void`	`setDocumentVersion(String documentVersion)` The document version.
`void`	`setName(String name)` The name of the SSM document.
`void`	`setOwner(String owner)` The Amazon Web Services user that created the document.
`void`	`setPlatformTypes(Collection<String> platformTypes)` The operating system platform.
`void`	`setRequires(Collection<DocumentRequires> requires)` A list of SSM documents required by a document.
`void`	`setReviewStatus(ReviewStatus reviewStatus)` The current status of a document review.
`void`	`setReviewStatus(String reviewStatus)` The current status of a document review.
`void`	`setSchemaVersion(String schemaVersion)` The schema version.
`void`	`setTags(Collection<Tag> tags)` The tags, or metadata, that have been applied to the document.
`void`	`setTargetType(String targetType)` The target type which defines the kinds of resources the document can run on.
`void`	`setVersionName(String versionName)` An optional field specifying the version of the artifact associated with the document.
`String`	`toString()` Returns a string representation of this object.
`DocumentIdentifier`	`withAuthor(String author)` The user in your organization who created the document.
`DocumentIdentifier`	`withCreatedDate(Date createdDate)` The date the SSM document was created.
`DocumentIdentifier`	`withDisplayName(String displayName)` An optional field where you can specify a friendly name for the SSM document.
`DocumentIdentifier`	`withDocumentFormat(DocumentFormat documentFormat)` The document format, either JSON or YAML.
`DocumentIdentifier`	`withDocumentFormat(String documentFormat)` The document format, either JSON or YAML.
`DocumentIdentifier`	`withDocumentType(DocumentType documentType)` The document type.
`DocumentIdentifier`	`withDocumentType(String documentType)` The document type.
`DocumentIdentifier`	`withDocumentVersion(String documentVersion)` The document version.
`DocumentIdentifier`	`withName(String name)` The name of the SSM document.
`DocumentIdentifier`	`withOwner(String owner)` The Amazon Web Services user that created the document.
`DocumentIdentifier`	`withPlatformTypes(Collection<String> platformTypes)` The operating system platform.
`DocumentIdentifier`	`withPlatformTypes(PlatformType... platformTypes)` The operating system platform.
`DocumentIdentifier`	`withPlatformTypes(String... platformTypes)` The operating system platform.
`DocumentIdentifier`	`withRequires(Collection<DocumentRequires> requires)` A list of SSM documents required by a document.
`DocumentIdentifier`	`withRequires(DocumentRequires... requires)` A list of SSM documents required by a document.
`DocumentIdentifier`	`withReviewStatus(ReviewStatus reviewStatus)` The current status of a document review.
`DocumentIdentifier`	`withReviewStatus(String reviewStatus)` The current status of a document review.
`DocumentIdentifier`	`withSchemaVersion(String schemaVersion)` The schema version.
`DocumentIdentifier`	`withTags(Collection<Tag> tags)` The tags, or metadata, that have been applied to the document.
`DocumentIdentifier`	`withTags(Tag... tags)` The tags, or metadata, that have been applied to the document.
`DocumentIdentifier`	`withTargetType(String targetType)` The target type which defines the kinds of resources the document can run on.
`DocumentIdentifier`	`withVersionName(String versionName)` An optional field specifying the version of the artifact associated with the document.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentIdentifier
```
public DocumentIdentifier()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the SSM document.
    
    Parameters:
    
    name - The name of the SSM document.
  - getName
```
public String getName()
```
    The name of the SSM document.
    
    Returns:
    
    The name of the SSM document.
  - withName
```
public DocumentIdentifier withName(String name)
```
    The name of the SSM document.
    
    Parameters:
    
    name - The name of the SSM document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedDate
```
public void setCreatedDate(Date createdDate)
```
    The date the SSM document was created.
    
    Parameters:
    
    createdDate - The date the SSM document was created.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The date the SSM document was created.
    
    Returns:
    
    The date the SSM document was created.
  - withCreatedDate
```
public DocumentIdentifier withCreatedDate(Date createdDate)
```
    The date the SSM document was created.
    
    Parameters:
    
    createdDate - The date the SSM document was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
    
    Parameters:
    
    displayName - An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
  - getDisplayName
```
public String getDisplayName()
```
    An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
    
    Returns:
    
    An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
  - withDisplayName
```
public DocumentIdentifier withDisplayName(String displayName)
```
    An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
    
    Parameters:
    
    displayName - An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOwner
```
public void setOwner(String owner)
```
    The Amazon Web Services user that created the document.
    
    Parameters:
    
    owner - The Amazon Web Services user that created the document.
  - getOwner
```
public String getOwner()
```
    The Amazon Web Services user that created the document.
    
    Returns:
    
    The Amazon Web Services user that created the document.
  - withOwner
```
public DocumentIdentifier withOwner(String owner)
```
    The Amazon Web Services user that created the document.
    
    Parameters:
    
    owner - The Amazon Web Services user that created the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersionName
```
public void setVersionName(String versionName)
```
    An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
    
    Parameters:
    
    versionName - An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
  - getVersionName
```
public String getVersionName()
```
    An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
    
    Returns:
    
    An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
  - withVersionName
```
public DocumentIdentifier withVersionName(String versionName)
```
    An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
    
    Parameters:
    
    versionName - An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPlatformTypes
```
public List<String> getPlatformTypes()
```
    The operating system platform.
    
    Returns:
    
    The operating system platform.
    
    See Also:
    
    PlatformType
  - setPlatformTypes
```
public void setPlatformTypes(Collection<String> platformTypes)
```
    The operating system platform.
    
    Parameters:
    
    platformTypes - The operating system platform.
    
    See Also:
    
    PlatformType
  - withPlatformTypes
```
public DocumentIdentifier withPlatformTypes(String... platformTypes)
```
    The operating system platform.
    
    NOTE: This method appends the values to the existing list (if any). Use setPlatformTypes(java.util.Collection) or withPlatformTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    platformTypes - The operating system platform.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformType
  - withPlatformTypes
```
public DocumentIdentifier withPlatformTypes(Collection<String> platformTypes)
```
    The operating system platform.
    
    Parameters:
    
    platformTypes - The operating system platform.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformType
  - withPlatformTypes
```
public DocumentIdentifier withPlatformTypes(PlatformType... platformTypes)
```
    The operating system platform.
    
    Parameters:
    
    platformTypes - The operating system platform.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformType
  - setDocumentVersion
```
public void setDocumentVersion(String documentVersion)
```
    The document version.
    
    Parameters:
    
    documentVersion - The document version.
  - getDocumentVersion
```
public String getDocumentVersion()
```
    The document version.
    
    Returns:
    
    The document version.
  - withDocumentVersion
```
public DocumentIdentifier withDocumentVersion(String documentVersion)
```
    The document version.
    
    Parameters:
    
    documentVersion - The document version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentType
```
public void setDocumentType(String documentType)
```
    The document type.
    
    Parameters:
    
    documentType - The document type.
    
    See Also:
    
    DocumentType
  - getDocumentType
```
public String getDocumentType()
```
    The document type.
    
    Returns:
    
    The document type.
    
    See Also:
    
    DocumentType
  - withDocumentType
```
public DocumentIdentifier withDocumentType(String documentType)
```
    The document type.
    
    Parameters:
    
    documentType - The document type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentType
  - setDocumentType
```
public void setDocumentType(DocumentType documentType)
```
    The document type.
    
    Parameters:
    
    documentType - The document type.
    
    See Also:
    
    DocumentType
  - withDocumentType
```
public DocumentIdentifier withDocumentType(DocumentType documentType)
```
    The document type.
    
    Parameters:
    
    documentType - The document type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentType
  - setSchemaVersion
```
public void setSchemaVersion(String schemaVersion)
```
    The schema version.
    
    Parameters:
    
    schemaVersion - The schema version.
  - getSchemaVersion
```
public String getSchemaVersion()
```
    The schema version.
    
    Returns:
    
    The schema version.
  - withSchemaVersion
```
public DocumentIdentifier withSchemaVersion(String schemaVersion)
```
    The schema version.
    
    Parameters:
    
    schemaVersion - The schema version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentFormat
```
public void setDocumentFormat(String documentFormat)
```
    The document format, either JSON or YAML.
    
    Parameters:
    
    documentFormat - The document format, either JSON or YAML.
    
    See Also:
    
    DocumentFormat
  - getDocumentFormat
```
public String getDocumentFormat()
```
    The document format, either JSON or YAML.
    
    Returns:
    
    The document format, either JSON or YAML.
    
    See Also:
    
    DocumentFormat
  - withDocumentFormat
```
public DocumentIdentifier withDocumentFormat(String documentFormat)
```
    The document format, either JSON or YAML.
    
    Parameters:
    
    documentFormat - The document format, either JSON or YAML.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentFormat
  - setDocumentFormat
```
public void setDocumentFormat(DocumentFormat documentFormat)
```
    The document format, either JSON or YAML.
    
    Parameters:
    
    documentFormat - The document format, either JSON or YAML.
    
    See Also:
    
    DocumentFormat
  - withDocumentFormat
```
public DocumentIdentifier withDocumentFormat(DocumentFormat documentFormat)
```
    The document format, either JSON or YAML.
    
    Parameters:
    
    documentFormat - The document format, either JSON or YAML.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentFormat
  - setTargetType
```
public void setTargetType(String targetType)
```
    The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
    
    Parameters:
    
    targetType - The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
  - getTargetType
```
public String getTargetType()
```
    The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
    
    Returns:
    
    The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
  - withTargetType
```
public DocumentIdentifier withTargetType(String targetType)
```
    The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
    
    Parameters:
    
    targetType - The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    The tags, or metadata, that have been applied to the document.
    
    Returns:
    
    The tags, or metadata, that have been applied to the document.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The tags, or metadata, that have been applied to the document.
    
    Parameters:
    
    tags - The tags, or metadata, that have been applied to the document.
  - withTags
```
public DocumentIdentifier withTags(Tag... tags)
```
    The tags, or metadata, that have been applied to the document.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - The tags, or metadata, that have been applied to the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public DocumentIdentifier withTags(Collection<Tag> tags)
```
    The tags, or metadata, that have been applied to the document.
    
    Parameters:
    
    tags - The tags, or metadata, that have been applied to the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRequires
```
public List<DocumentRequires> getRequires()
```
    A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
    
    Returns:
    
    A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
  - setRequires
```
public void setRequires(Collection<DocumentRequires> requires)
```
    A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
    
    Parameters:
    
    requires - A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
  - withRequires
```
public DocumentIdentifier withRequires(DocumentRequires... requires)
```
    A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
    
    NOTE: This method appends the values to the existing list (if any). Use setRequires(java.util.Collection) or withRequires(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    requires - A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRequires
```
public DocumentIdentifier withRequires(Collection<DocumentRequires> requires)
```
    A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
    
    Parameters:
    
    requires - A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReviewStatus
```
public void setReviewStatus(String reviewStatus)
```
    The current status of a document review.
    
    Parameters:
    
    reviewStatus - The current status of a document review.
    
    See Also:
    
    ReviewStatus
  - getReviewStatus
```
public String getReviewStatus()
```
    The current status of a document review.
    
    Returns:
    
    The current status of a document review.
    
    See Also:
    
    ReviewStatus
  - withReviewStatus
```
public DocumentIdentifier withReviewStatus(String reviewStatus)
```
    The current status of a document review.
    
    Parameters:
    
    reviewStatus - The current status of a document review.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReviewStatus
  - setReviewStatus
```
public void setReviewStatus(ReviewStatus reviewStatus)
```
    The current status of a document review.
    
    Parameters:
    
    reviewStatus - The current status of a document review.
    
    See Also:
    
    ReviewStatus
  - withReviewStatus
```
public DocumentIdentifier withReviewStatus(ReviewStatus reviewStatus)
```
    The current status of a document review.
    
    Parameters:
    
    reviewStatus - The current status of a document review.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReviewStatus
  - setAuthor
```
public void setAuthor(String author)
```
    The user in your organization who created the document.
    
    Parameters:
    
    author - The user in your organization who created the document.
  - getAuthor
```
public String getAuthor()
```
    The user in your organization who created the document.
    
    Returns:
    
    The user in your organization who created the document.
  - withAuthor
```
public DocumentIdentifier withAuthor(String author)
```
    The user in your organization who created the document.
    
    Parameters:
    
    author - The user in your organization who created the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DocumentIdentifier clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.777

Class DocumentIdentifier

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentIdentifier

Method Detail

setName

getName

withName

setCreatedDate

getCreatedDate

withCreatedDate

setDisplayName

getDisplayName

withDisplayName

setOwner

getOwner

withOwner

setVersionName

getVersionName

withVersionName

getPlatformTypes

setPlatformTypes

withPlatformTypes

withPlatformTypes

withPlatformTypes

setDocumentVersion

getDocumentVersion

withDocumentVersion

setDocumentType

getDocumentType

withDocumentType

setDocumentType

withDocumentType

setSchemaVersion

getSchemaVersion

withSchemaVersion

setDocumentFormat

getDocumentFormat

withDocumentFormat

setDocumentFormat

withDocumentFormat

setTargetType

getTargetType

withTargetType

getTags

setTags

withTags

withTags

getRequires

setRequires

withRequires

withRequires

setReviewStatus

getReviewStatus

withReviewStatus

setReviewStatus

withReviewStatus

setAuthor

getAuthor

withAuthor

toString

equals

hashCode

clone

marshall