Class GetPatchBaselineResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.ssm.model.SsmResponse
software.amazon.awssdk.services.ssm.model.GetPatchBaselineResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetPatchBaselineResponse.Builder,GetPatchBaselineResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetPatchBaselineResponse extends SsmResponse implements ToCopyableBuilder<GetPatchBaselineResponse.Builder,GetPatchBaselineResponse>

  • Method Details

    • baselineId

      public final String baselineId()

      The ID of the retrieved patch baseline.

      Returns:
      The ID of the retrieved patch baseline.

    • name

      public final String name()

      The name of the patch baseline.

      Returns:
      The name of the patch baseline.

    • operatingSystem

      public final OperatingSystem operatingSystem()

      Returns the operating system specified for the patch baseline.

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

      Returns:
      Returns the operating system specified for the patch baseline.
      See Also:

    • operatingSystemAsString

      public final String operatingSystemAsString()

      Returns the operating system specified for the patch baseline.

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

      Returns:
      Returns the operating system specified for the patch baseline.
      See Also:

    • globalFilters

      public final PatchFilterGroup globalFilters()

      A set of global filters used to exclude patches from the baseline.

      Returns:
      A set of global filters used to exclude patches from the baseline.

    • approvalRules

      public final PatchRuleGroup approvalRules()

      A set of rules used to include patches in the baseline.

      Returns:
      A set of rules used to include patches in the baseline.

    • hasApprovedPatches

      public final boolean hasApprovedPatches()
      For responses, this returns true if the service returned a value for the ApprovedPatches 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.

    • approvedPatches

      public final List<String> approvedPatches()

      A list of explicitly approved patches for the baseline.

      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 hasApprovedPatches() method.

      Returns:
      A list of explicitly approved patches for the baseline.

    • approvedPatchesComplianceLevel

      public final PatchComplianceLevel approvedPatchesComplianceLevel()

      Returns the specified compliance severity level for approved patches in the patch baseline.

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

      Returns:
      Returns the specified compliance severity level for approved patches in the patch baseline.
      See Also:

    • approvedPatchesComplianceLevelAsString

      public final String approvedPatchesComplianceLevelAsString()

      Returns the specified compliance severity level for approved patches in the patch baseline.

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

      Returns:
      Returns the specified compliance severity level for approved patches in the patch baseline.
      See Also:

    • approvedPatchesEnableNonSecurity

      public final Boolean approvedPatchesEnableNonSecurity()

      Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only.

      Returns:
      Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only.

    • hasRejectedPatches

      public final boolean hasRejectedPatches()
      For responses, this returns true if the service returned a value for the RejectedPatches 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.

    • rejectedPatches

      public final List<String> rejectedPatches()

      A list of explicitly rejected patches for the baseline.

      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 hasRejectedPatches() method.

      Returns:
      A list of explicitly rejected patches for the baseline.

    • rejectedPatchesAction

      public final PatchAction rejectedPatchesAction()

      The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.

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

      Returns:
      The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.
      See Also:

    • rejectedPatchesActionAsString

      public final String rejectedPatchesActionAsString()

      The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.

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

      Returns:
      The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.
      See Also:

    • hasPatchGroups

      public final boolean hasPatchGroups()
      For responses, this returns true if the service returned a value for the PatchGroups 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.

    • patchGroups

      public final List<String> patchGroups()

      Patch groups included in the patch baseline.

      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 hasPatchGroups() method.

      Returns:
      Patch groups included in the patch baseline.

    • createdDate

      public final Instant createdDate()

      The date the patch baseline was created.

      Returns:
      The date the patch baseline was created.

    • modifiedDate

      public final Instant modifiedDate()

      The date the patch baseline was last modified.

      Returns:
      The date the patch baseline was last modified.

    • description

      public final String description()

      A description of the patch baseline.

      Returns:
      A description of the patch baseline.

    • hasSources

      public final boolean hasSources()
      For responses, this returns true if the service returned a value for the Sources 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.

    • sources

      public final List<PatchSource> sources()

      Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

      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 hasSources() method.

      Returns:
      Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.

    • toBuilder

      public GetPatchBaselineResponse.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<GetPatchBaselineResponse.Builder,GetPatchBaselineResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetPatchBaselineResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.