software.amazon.awssdk.services.ssm.model

Class Patch

java.lang.Object

software.amazon.awssdk.services.ssm.model.Patch

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Patch.Builder,Patch>

@Generated(value="software.amazon.awssdk:codegen")
public final class Patch
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Patch.Builder,Patch>

Represents metadata about a patch.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Patch.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	advisoryIds() The Advisory ID of the patch.
String	arch() The architecture of the patch.
List<String>	bugzillaIds() The Bugzilla ID of the patch.
static Patch.Builder	builder()
String	classification() The classification of the patch.
String	contentUrl() The URL where more information can be obtained about the patch.
List<String>	cveIds() The Common Vulnerabilities and Exposures (CVE) ID of the patch.
String	description() The description of the patch.
Integer	epoch() The epoch of the patch.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdvisoryIds() For responses, this returns true if the service returned a value for the AdvisoryIds property.
boolean	hasBugzillaIds() For responses, this returns true if the service returned a value for the BugzillaIds property.
boolean	hasCveIds() For responses, this returns true if the service returned a value for the CVEIds property.
int	hashCode()
String	id() The ID of the patch.
String	kbNumber() The Microsoft Knowledge Base ID of the patch.
String	language() The language of the patch if it's language-specific.
String	msrcNumber() The ID of the Microsoft Security Response Center (MSRC) bulletin the patch is related to.
String	msrcSeverity() The severity of the patch, such as Critical, Important, or Moderate.
String	name() The name of the patch.
String	product() The specific product the patch is applicable for.
String	productFamily() The product family the patch is applicable for.
String	release() The particular release of a patch.
Instant	releaseDate() The date the patch was released.
String	repository() The source patch repository for the operating system and version, such as trusty-security for Ubuntu Server 14.04 LTE and focal-security for Ubuntu Server 20.04 LTE.
List<SdkField<?>>	sdkFields()
static Class<? extends Patch.Builder>	serializableBuilderClass()
String	severity() The severity level of the patch.
String	title() The title of the patch.
Patch.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vendor() The name of the vendor providing the patch.
String	version() The version number of the patch.

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

id

public final String id()

The ID of the patch. Applies to Windows patches only.

This ID isn't the same as the Microsoft Knowledge Base ID.

Returns:

The ID of the patch. Applies to Windows patches only.

This ID isn't the same as the Microsoft Knowledge Base ID.

releaseDate

public final Instant releaseDate()

The date the patch was released.

Returns:

The date the patch was released.

title

public final String title()

The title of the patch.

Returns:

The title of the patch.

description

public final String description()

The description of the patch.

Returns:

The description of the patch.

contentUrl

public final String contentUrl()

The URL where more information can be obtained about the patch.

Returns:

The URL where more information can be obtained about the patch.

vendor

public final String vendor()

The name of the vendor providing the patch.

Returns:

The name of the vendor providing the patch.

productFamily

public final String productFamily()

The product family the patch is applicable for. For example, Windows or Amazon Linux 2.

Returns:

The product family the patch is applicable for. For example, Windows or Amazon Linux 2.

product

public final String product()

The specific product the patch is applicable for. For example, WindowsServer2016 or AmazonLinux2018.03.

Returns:

The specific product the patch is applicable for. For example, WindowsServer2016 or AmazonLinux2018.03.

classification

public final String classification()

The classification of the patch. For example, SecurityUpdates, Updates, or CriticalUpdates.

Returns:

The classification of the patch. For example, SecurityUpdates, Updates, or CriticalUpdates.

msrcSeverity

public final String msrcSeverity()

The severity of the patch, such as Critical, Important, or Moderate. Applies to Windows patches only.

Returns:

The severity of the patch, such as Critical, Important, or Moderate. Applies to Windows patches only.

kbNumber

public final String kbNumber()

The Microsoft Knowledge Base ID of the patch. Applies to Windows patches only.

Returns:

The Microsoft Knowledge Base ID of the patch. Applies to Windows patches only.

msrcNumber

public final String msrcNumber()

The ID of the Microsoft Security Response Center (MSRC) bulletin the patch is related to. For example, MS14-045. Applies to Windows patches only.

Returns:

The ID of the Microsoft Security Response Center (MSRC) bulletin the patch is related to. For example, MS14-045. Applies to Windows patches only.

language

public final String language()

The language of the patch if it's language-specific.

Returns:

The language of the patch if it's language-specific.

hasAdvisoryIds

public final boolean hasAdvisoryIds()

For responses, this returns true if the service returned a value for the AdvisoryIds 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.

advisoryIds

public final List<String> advisoryIds()

The Advisory ID of the patch. For example, RHSA-2020:3779. Applies to Linux-based 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 hasAdvisoryIds() method.

Returns:

The Advisory ID of the patch. For example, RHSA-2020:3779. Applies to Linux-based managed nodes only.

hasBugzillaIds

public final boolean hasBugzillaIds()

For responses, this returns true if the service returned a value for the BugzillaIds 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.

bugzillaIds

public final List<String> bugzillaIds()

The Bugzilla ID of the patch. For example, 1600646. Applies to Linux-based 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 hasBugzillaIds() method.

Returns:

The Bugzilla ID of the patch. For example, 1600646. Applies to Linux-based managed nodes only.

hasCveIds

public final boolean hasCveIds()

For responses, this returns true if the service returned a value for the CVEIds 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.

cveIds

public final List<String> cveIds()

The Common Vulnerabilities and Exposures (CVE) ID of the patch. For example, CVE-2011-3192. Applies to Linux-based 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 hasCveIds() method.

Returns:

The Common Vulnerabilities and Exposures (CVE) ID of the patch. For example, CVE-2011-3192. Applies to Linux-based managed nodes only.

name

public final String name()

The name of the patch. Applies to Linux-based managed nodes only.

Returns:

The name of the patch. Applies to Linux-based managed nodes only.

epoch

public final Integer epoch()

The epoch of the patch. For example in pkg-example-EE-20180914-2.2.amzn1.noarch, the epoch value is 20180914-2. Applies to Linux-based managed nodes only.

Returns:

The epoch of the patch. For example in pkg-example-EE-20180914-2.2.amzn1.noarch, the epoch value is 20180914-2. Applies to Linux-based managed nodes only.

version

public final String version()

The version number of the patch. For example, in example-pkg-1.710.10-2.7.abcd.x86_64, the version number is indicated by -1. Applies to Linux-based managed nodes only.

Returns:

The version number of the patch. For example, in example-pkg-1.710.10-2.7.abcd.x86_64, the version number is indicated by -1. Applies to Linux-based managed nodes only.

release

public final String release()

The particular release of a patch. For example, in pkg-example-EE-20180914-2.2.amzn1.noarch, the release is 2.amaz1. Applies to Linux-based managed nodes only.

Returns:

The particular release of a patch. For example, in pkg-example-EE-20180914-2.2.amzn1.noarch, the release is 2.amaz1. Applies to Linux-based managed nodes only.

arch

public final String arch()

The architecture of the patch. For example, in example-pkg-0.710.10-2.7.abcd.x86_64, the architecture is indicated by x86_64. Applies to Linux-based managed nodes only.

Returns:

The architecture of the patch. For example, in example-pkg-0.710.10-2.7.abcd.x86_64, the architecture is indicated by x86_64. Applies to Linux-based managed nodes only.

severity

public final String severity()

The severity level of the patch. For example, CRITICAL or MODERATE.

Returns:

The severity level of the patch. For example, CRITICAL or MODERATE.

repository

public final String repository()

The source patch repository for the operating system and version, such as trusty-security for Ubuntu Server 14.04 LTE and focal-security for Ubuntu Server 20.04 LTE. Applies to Linux-based managed nodes only.

Returns:

The source patch repository for the operating system and version, such as trusty-security for Ubuntu Server 14.04 LTE and focal-security for Ubuntu Server 20.04 LTE. Applies to Linux-based managed nodes only.

toBuilder

public Patch.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Patch.Builder,Patch>

builder

public static Patch.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo