InstancePatchState (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.10.42 API)

java.lang.Object
- software.amazon.awssdk.services.ssm.model.InstancePatchState

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InstancePatchState.Builder,InstancePatchState>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class InstancePatchState
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InstancePatchState.Builder,InstancePatchState>
```
Defines the high-level patch compliance state for a managed instance, providing information about the number of installed, missing, not applicable, and failed patches along with metadata about the operation when this information was gathered for the instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface InstancePatchState.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`InstancePatchState.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`baselineId()` The ID of the patch baseline used to patch the instance.
`static InstancePatchState.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Integer`	`failedCount()` The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`installedCount()` The number of patches from the patch baseline that are installed on the instance.
`Integer`	`installedOtherCount()` The number of patches not specified in the patch baseline that are installed on the instance.
`Integer`	`installedPendingRebootCount()` Reserved for future use.
`Integer`	`installedRejectedCount()` The number of instances with patches installed that are specified in a RejectedPatches list.
`String`	`installOverrideList()` An https URL or an Amazon S3 path-style URL to a list of patches to be installed.
`String`	`instanceId()` The ID of the managed instance the high-level patch compliance information was collected for.
`Instant`	`lastNoRebootInstallOperationTime()` Reserved for future use.
`Integer`	`missingCount()` The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.
`Integer`	`notApplicableCount()` The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't installed on the instance.
`PatchOperationType`	`operation()` The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).
`String`	`operationAsString()` The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).
`Instant`	`operationEndTime()` The time the most recent patching operation completed on the instance.
`Instant`	`operationStartTime()` The time the most recent patching operation was started on the instance.
`String`	`ownerInformation()` Placeholder information.
`String`	`patchGroup()` The name of the patch group the managed instance belongs to.
`RebootOption`	`rebootOption()` Reserved for future use.
`String`	`rebootOptionAsString()` Reserved for future use.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InstancePatchState.Builder>`	`serializableBuilderClass()`
`String`	`snapshotId()` The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
`InstancePatchState.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Integer`	`unreportedNotApplicableCount()` The number of patches beyond the supported limit of `NotApplicableCount` that are not reported by name to Systems Manager Inventory.

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
  - instanceId
```
public String instanceId()
```
    The ID of the managed instance the high-level patch compliance information was collected for.
    
    Returns:
    
    The ID of the managed instance the high-level patch compliance information was collected for.
  - patchGroup
```
public String patchGroup()
```
    The name of the patch group the managed instance belongs to.
    
    Returns:
    
    The name of the patch group the managed instance belongs to.
  - baselineId
```
public String baselineId()
```
    The ID of the patch baseline used to patch the instance.
    
    Returns:
    
    The ID of the patch baseline used to patch the instance.
  - snapshotId
```
public String snapshotId()
```
    The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
    
    Returns:
    
    The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
  - installOverrideList
```
public String installOverrideList()
```
    An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an Amazon S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline.
    
    For more information about the InstallOverrideList parameter, see About the SSM Document AWS-RunPatchBaseline in the AWS Systems Manager User Guide.
    
    Returns:
    
    An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an Amazon S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline.
    
    For more information about the InstallOverrideList parameter, see About the SSM Document AWS-RunPatchBaseline in the AWS Systems Manager User Guide.
  - ownerInformation
```
public String ownerInformation()
```
    Placeholder information. This field will always be empty in the current release of the service.
    
    Returns:
    
    Placeholder information. This field will always be empty in the current release of the service.
  - installedCount
```
public Integer installedCount()
```
    The number of patches from the patch baseline that are installed on the instance.
    
    Returns:
    
    The number of patches from the patch baseline that are installed on the instance.
  - installedOtherCount
```
public Integer installedOtherCount()
```
    The number of patches not specified in the patch baseline that are installed on the instance.
    
    Returns:
    
    The number of patches not specified in the patch baseline that are installed on the instance.
  - installedPendingRebootCount
```
public Integer installedPendingRebootCount()
```
    Reserved for future use.
    
    Returns:
    
    Reserved for future use.
  - installedRejectedCount
```
public Integer installedRejectedCount()
```
    The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list.
    
    If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).
    
    Returns:
    
    The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list.
    
    If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).
  - missingCount
```
public Integer missingCount()
```
    The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.
    
    Returns:
    
    The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.
  - failedCount
```
public Integer failedCount()
```
    The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.
    
    Returns:
    
    The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.
  - unreportedNotApplicableCount
```
public Integer unreportedNotApplicableCount()
```
    The number of patches beyond the supported limit of NotApplicableCount that are not reported by name to Systems Manager Inventory.
    
    Returns:
    
    The number of patches beyond the supported limit of NotApplicableCount that are not reported by name to Systems Manager Inventory.
  - notApplicableCount
```
public Integer notApplicableCount()
```
    The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't installed on the instance. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount.
    
    Returns:
    
    The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't installed on the instance. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount.
  - operationStartTime
```
public Instant operationStartTime()
```
    The time the most recent patching operation was started on the instance.
    
    Returns:
    
    The time the most recent patching operation was started on the instance.
  - operationEndTime
```
public Instant operationEndTime()
```
    The time the most recent patching operation completed on the instance.
    
    Returns:
    
    The time the most recent patching operation completed on the instance.
  - operation
```
public PatchOperationType operation()
```
    The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).
    
    If the service returns an enum value that is not available in the current SDK version, operation will return PatchOperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationAsString().
    
    Returns:
    
    The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).
    
    See Also:
    
    PatchOperationType
  - operationAsString
```
public String operationAsString()
```
    The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).
    
    If the service returns an enum value that is not available in the current SDK version, operation will return PatchOperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationAsString().
    
    Returns:
    
    The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).
    
    See Also:
    
    PatchOperationType
  - lastNoRebootInstallOperationTime
```
public Instant lastNoRebootInstallOperationTime()
```
    Reserved for future use.
    
    Returns:
    
    Reserved for future use.
  - rebootOption
```
public RebootOption rebootOption()
```
    Reserved for future use.
    
    If the service returns an enum value that is not available in the current SDK version, rebootOption will return RebootOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rebootOptionAsString().
    
    Returns:
    
    Reserved for future use.
    
    See Also:
    
    RebootOption
  - rebootOptionAsString
```
public String rebootOptionAsString()
```
    Reserved for future use.
    
    If the service returns an enum value that is not available in the current SDK version, rebootOption will return RebootOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rebootOptionAsString().
    
    Returns:
    
    Reserved for future use.
    
    See Also:
    
    RebootOption
  - toBuilder
```
public InstancePatchState.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InstancePatchState.Builder,InstancePatchState>
  - builder
```
public static InstancePatchState.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends InstancePatchState.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class InstancePatchState

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

instanceId

patchGroup

baselineId

snapshotId

installOverrideList

ownerInformation

installedCount

installedOtherCount

installedPendingRebootCount

installedRejectedCount

missingCount

failedCount

unreportedNotApplicableCount

notApplicableCount

operationStartTime

operationEndTime

operation

operationAsString

lastNoRebootInstallOperationTime

rebootOption

rebootOptionAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields