@Generated(value="software.amazon.awssdk:codegen") public final class DocumentIdentifier extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DocumentIdentifier.Builder,DocumentIdentifier>
Describes the name of a Systems Manager document.
Modifier and Type | Class and Description |
---|---|
static interface |
DocumentIdentifier.Builder |
Modifier and Type | Method and Description |
---|---|
String |
author()
The user in your organization who created the document.
|
static DocumentIdentifier.Builder |
builder() |
DocumentFormat |
documentFormat()
The document format, either JSON or YAML.
|
String |
documentFormatAsString()
The document format, either JSON or YAML.
|
DocumentType |
documentType()
The document type.
|
String |
documentTypeAsString()
The document type.
|
String |
documentVersion()
The document version.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasPlatformTypes()
Returns true if the PlatformTypes property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasRequires()
Returns true if the Requires property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
String |
name()
The name of the Systems Manager document.
|
String |
owner()
The AWS user account that created the document.
|
List<PlatformType> |
platformTypes()
The operating system platform.
|
List<String> |
platformTypesAsStrings()
The operating system platform.
|
List<DocumentRequires> |
requires()
A list of SSM documents required by a document.
|
ReviewStatus |
reviewStatus()
The current status of a document review.
|
String |
reviewStatusAsString()
The current status of a document review.
|
String |
schemaVersion()
The schema version.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DocumentIdentifier.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
The tags, or metadata, that have been applied to the document.
|
String |
targetType()
The target type which defines the kinds of resources the document can run on.
|
DocumentIdentifier.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
String |
versionName()
An optional field specifying the version of the artifact associated with the document.
|
copy
public final String name()
The name of the Systems Manager document.
public final String owner()
The AWS user account that created the document.
public final String versionName()
An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.
public final List<PlatformType> platformTypes()
The operating system platform.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasPlatformTypes()
to see if a value was sent in this field.
public final boolean hasPlatformTypes()
public final List<String> platformTypesAsStrings()
The operating system platform.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasPlatformTypes()
to see if a value was sent in this field.
public final String documentVersion()
The document version.
public final DocumentType documentType()
The document type.
If the service returns an enum value that is not available in the current SDK version, documentType
will
return DocumentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
documentTypeAsString()
.
DocumentType
public final String documentTypeAsString()
The document type.
If the service returns an enum value that is not available in the current SDK version, documentType
will
return DocumentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
documentTypeAsString()
.
DocumentType
public final String schemaVersion()
The schema version.
public final DocumentFormat documentFormat()
The document format, either JSON or YAML.
If the service returns an enum value that is not available in the current SDK version, documentFormat
will return DocumentFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from documentFormatAsString()
.
DocumentFormat
public final String documentFormatAsString()
The document format, either JSON or YAML.
If the service returns an enum value that is not available in the current SDK version, documentFormat
will return DocumentFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from documentFormatAsString()
.
DocumentFormat
public final 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 AWS resource and property types reference in the AWS CloudFormation User Guide.
public final boolean hasTags()
public final List<Tag> tags()
The tags, or metadata, that have been applied to the document.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags()
to see if a value was sent in this field.
public final boolean hasRequires()
public final List<DocumentRequires> requires()
A list of SSM documents required by a document. For example, an ApplicationConfiguration
document
requires an ApplicationConfigurationSchema
document.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasRequires()
to see if a value was sent in this field.
ApplicationConfiguration
document requires an ApplicationConfigurationSchema
document.public final ReviewStatus reviewStatus()
The current status of a document review.
If the service returns an enum value that is not available in the current SDK version, reviewStatus
will
return ReviewStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
reviewStatusAsString()
.
ReviewStatus
public final String reviewStatusAsString()
The current status of a document review.
If the service returns an enum value that is not available in the current SDK version, reviewStatus
will
return ReviewStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
reviewStatusAsString()
.
ReviewStatus
public final String author()
The user in your organization who created the document.
public DocumentIdentifier.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DocumentIdentifier.Builder,DocumentIdentifier>
public static DocumentIdentifier.Builder builder()
public static Class<? extends DocumentIdentifier.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.