Class DescribePatchPropertiesRequest

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.DescribePatchPropertiesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribePatchPropertiesRequest.Builder,DescribePatchPropertiesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribePatchPropertiesRequest extends SsmRequest implements ToCopyableBuilder<DescribePatchPropertiesRequest.Builder,DescribePatchPropertiesRequest>

  • Method Details

    • operatingSystem

      public final OperatingSystem operatingSystem()

      The operating system type for which to list patches.

      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:
      The operating system type for which to list patches.
      See Also:

    • operatingSystemAsString

      public final String operatingSystemAsString()

      The operating system type for which to list patches.

      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:
      The operating system type for which to list patches.
      See Also:

    • property

      public final PatchProperty property()

      The patch property for which you want to view patch details.

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

      Returns:
      The patch property for which you want to view patch details.
      See Also:

    • propertyAsString

      public final String propertyAsString()

      The patch property for which you want to view patch details.

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

      Returns:
      The patch property for which you want to view patch details.
      See Also:

    • patchSet

      public final PatchSet patchSet()

      Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems.

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

      Returns:
      Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems.
      See Also:

    • patchSetAsString

      public final String patchSetAsString()

      Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems.

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

      Returns:
      Indicates whether to list patches for the Windows operating system or for applications released by Microsoft. Not applicable for the Linux or macOS operating systems.
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

      Returns:
      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    • nextToken

      public final String nextToken()

      The token for the next set of items to return. (You received this token from a previous call.)

      Returns:
      The token for the next set of items to return. (You received this token from a previous call.)

    • toBuilder

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

    • builder

      public static DescribePatchPropertiesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribePatchPropertiesRequest.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.