software.amazon.awssdk.services.ssm.model

Class PutComplianceItemsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.PutComplianceItemsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutComplianceItemsRequest.Builder,PutComplianceItemsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PutComplianceItemsRequest
extends SsmRequest
implements ToCopyableBuilder<PutComplianceItemsRequest.Builder,PutComplianceItemsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutComplianceItemsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static PutComplianceItemsRequest.Builder	builder()
String	complianceType() Specify the compliance type.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ComplianceExecutionSummary	executionSummary() A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasItems() For responses, this returns true if the service returned a value for the Items property.
String	itemContentHash() MD5 or SHA-256 content hash.
List<ComplianceItemEntry>	items() Information about the compliance as defined by the resource type.
String	resourceId() Specify an ID for this resource.
String	resourceType() Specify the type of resource.
List<SdkField<?>>	sdkFields()
static Class<? extends PutComplianceItemsRequest.Builder>	serializableBuilderClass()
PutComplianceItemsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
ComplianceUploadType	uploadType() The mode for uploading compliance items.
String	uploadTypeAsString() The mode for uploading compliance items.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

resourceId

public final String resourceId()

Specify an ID for this resource. For a managed instance, this is the instance ID.

Returns:

Specify an ID for this resource. For a managed instance, this is the instance ID.

resourceType

public final String resourceType()

Specify the type of resource. ManagedInstance is currently the only supported resource type.

Returns:

Specify the type of resource. ManagedInstance is currently the only supported resource type.

complianceType

public final String complianceType()

Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string.

Returns:

Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string.

executionSummary

public final ComplianceExecutionSummary executionSummary()

A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

Returns:

A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

hasItems

public final boolean hasItems()

For responses, this returns true if the service returned a value for the Items property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

items

public final List<ComplianceItemEntry> items()

Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, and so on.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasItems() method.

Returns:

Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, and so on.

itemContentHash

public final String itemContentHash()

MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.

Returns:

MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.

uploadType

public final ComplianceUploadType uploadType()

The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In COMPLETE mode, the system overwrites all existing compliance information for the resource. You must provide a full list of compliance items each time you send the request.

In PARTIAL mode, the system overwrites compliance information for a specific association. The association must be configured with SyncCompliance set to MANUAL. By default, all requests use COMPLETE mode.

This attribute is only valid for association compliance.

If the service returns an enum value that is not available in the current SDK version, uploadType will return ComplianceUploadType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from uploadTypeAsString().

Returns:

The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In COMPLETE mode, the system overwrites all existing compliance information for the resource. You must provide a full list of compliance items each time you send the request.

In PARTIAL mode, the system overwrites compliance information for a specific association. The association must be configured with SyncCompliance set to MANUAL. By default, all requests use COMPLETE mode.

This attribute is only valid for association compliance.

See Also:

ComplianceUploadType

uploadTypeAsString

public final String uploadTypeAsString()

The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In COMPLETE mode, the system overwrites all existing compliance information for the resource. You must provide a full list of compliance items each time you send the request.

In PARTIAL mode, the system overwrites compliance information for a specific association. The association must be configured with SyncCompliance set to MANUAL. By default, all requests use COMPLETE mode.

This attribute is only valid for association compliance.

If the service returns an enum value that is not available in the current SDK version, uploadType will return ComplianceUploadType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from uploadTypeAsString().

Returns:

The mode for uploading compliance items. You can specify COMPLETE or PARTIAL. In COMPLETE mode, the system overwrites all existing compliance information for the resource. You must provide a full list of compliance items each time you send the request.

In PARTIAL mode, the system overwrites compliance information for a specific association. The association must be configured with SyncCompliance set to MANUAL. By default, all requests use COMPLETE mode.

This attribute is only valid for association compliance.

See Also:

ComplianceUploadType

toBuilder

public PutComplianceItemsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutComplianceItemsRequest.Builder,PutComplianceItemsRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static PutComplianceItemsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutComplianceItemsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo