Package software.amazon.awssdk.services.securityhub.model

Class Resource

java.lang.Object

software.amazon.awssdk.services.securityhub.model.Resource

All Implemented Interfaces:

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

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

A resource related to a finding.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Resource.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationArn()	The Amazon Resource Name (ARN) of the application that is related to a finding.
String	applicationName()	The name of the application that is related to a finding.
static Resource.Builder	builder()
DataClassificationDetails	dataClassification()	Contains information about sensitive data that was detected on the resource.
ResourceDetails	details()	Additional details about the resource related to a finding.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	id()	The canonical identifier for the given resource type.
Partition	partition()	The canonical Amazon Web Services partition name that the Region is assigned to.
String	partitionAsString()	The canonical Amazon Web Services partition name that the Region is assigned to.
String	region()	The canonical Amazon Web Services external Region name where this resource is located.
String	resourceRole()	Identifies the role of the resource in the finding.
List<SdkField<?>>	sdkFields()
static Class<? extends Resource.Builder>	serializableBuilderClass()
Map<String,String>	tags()	A list of Amazon Web Services tags associated with a resource at the time the finding was processed.
Resource.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	type()	The type of the resource that details are provided for.

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

type

public final String type()

The type of the resource that details are provided for. If possible, set Type to one of the supported resource types. For example, if the resource is an EC2 instance, then set Type to AwsEc2Instance.

If the resource does not match any of the provided types, then set Type to Other.

Length Constraints: Minimum length of 1. Maximum length of 256.

Returns:

The type of the resource that details are provided for. If possible, set Type to one of the supported resource types. For example, if the resource is an EC2 instance, then set Type to AwsEc2Instance.

If the resource does not match any of the provided types, then set Type to Other.

Length Constraints: Minimum length of 1. Maximum length of 256.

id

public final String id()

The canonical identifier for the given resource type.

Returns:

The canonical identifier for the given resource type.

partition

public final Partition partition()

The canonical Amazon Web Services partition name that the Region is assigned to.

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

Returns:

The canonical Amazon Web Services partition name that the Region is assigned to.

See Also:

Partition

partitionAsString

public final String partitionAsString()

The canonical Amazon Web Services partition name that the Region is assigned to.

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

Returns:

The canonical Amazon Web Services partition name that the Region is assigned to.

See Also:

Partition

region

public final String region()

The canonical Amazon Web Services external Region name where this resource is located.

Length Constraints: Minimum length of 1. Maximum length of 16.

Returns:

The canonical Amazon Web Services external Region name where this resource is located.

Length Constraints: Minimum length of 1. Maximum length of 16.

resourceRole

public final String resourceRole()

Identifies the role of the resource in the finding. A resource is either the actor or target of the finding activity,

Returns:

Identifies the role of the resource in the finding. A resource is either the actor or target of the finding activity,

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

A list of Amazon Web Services tags associated with a resource at the time the finding was processed. Tags must follow Amazon Web Services tag naming limits and requirements.

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

Returns:

A list of Amazon Web Services tags associated with a resource at the time the finding was processed. Tags must follow Amazon Web Services tag naming limits and requirements.

dataClassification

public final DataClassificationDetails dataClassification()

Contains information about sensitive data that was detected on the resource.

Returns:

Contains information about sensitive data that was detected on the resource.

details

public final ResourceDetails details()

Additional details about the resource related to a finding.

Returns:

Additional details about the resource related to a finding.

applicationName

public final String applicationName()

The name of the application that is related to a finding.

Returns:

The name of the application that is related to a finding.

applicationArn

public final String applicationArn()

The Amazon Resource Name (ARN) of the application that is related to a finding.

Returns:

The Amazon Resource Name (ARN) of the application that is related to a finding.

toBuilder

public Resource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Resource.Builder,Resource>

builder

public static Resource.Builder builder()

serializableBuilderClass

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