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("software.amazon.awssdk:codegen") public final class PutComplianceItemsRequest extends SsmRequest implements ToCopyableBuilder<PutComplianceItemsRequest.Builder,PutComplianceItemsRequest>

  • Method Details

    • resourceId

      public final String resourceId()

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

      Returns:
      Specify an ID for this resource. For a managed node, this is the node 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:

    • 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:

    • toBuilder

      public PutComplianceItemsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutComplianceItemsRequest.Builder,PutComplianceItemsRequest>
      Specified by:
      toBuilder in class SsmRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.