Package software.amazon.awssdk.services.amp.model

Class ScraperSummary

java.lang.Object

software.amazon.awssdk.services.amp.model.ScraperSummary

All Implemented Interfaces:

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

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

Represents a summary of the properties of a scraper.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScraperSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	alias()	Alias of this scraper.
String	arn()	The Amazon Resource Name (ARN) of this scraper.
static ScraperSummary.Builder	builder()
Instant	createdAt()	The time when the scraper was created.
Destination	destination()	The destination that the scraper is producing metrics to.
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.
Instant	lastModifiedAt()	The time when the scraper was last modified.
String	roleArn()	The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.
String	scraperId()	Unique string identifying this scraper.
List<SdkField<?>>	sdkFields()
static Class<? extends ScraperSummary.Builder>	serializableBuilderClass()
Source	source()	The source that the scraper is discovering and collecting metrics from.
ScraperStatus	status()	The status of this scraper.
String	statusReason()	The reason for failure if any.
Map<String,String>	tags()	The tags of this scraper.
ScraperSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

alias

public final String alias()

Alias of this scraper.

Returns:

Alias of this scraper.

scraperId

public final String scraperId()

Unique string identifying this scraper.

Returns:

Unique string identifying this scraper.

arn

public final String arn()

The Amazon Resource Name (ARN) of this scraper.

Returns:

The Amazon Resource Name (ARN) of this scraper.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.

Returns:

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.

status

public final ScraperStatus status()

The status of this scraper.

Returns:

The status of this scraper.

createdAt

public final Instant createdAt()

The time when the scraper was created.

Returns:

The time when the scraper was created.

lastModifiedAt

public final Instant lastModifiedAt()

The time when the scraper was last modified.

Returns:

The time when the scraper was last modified.

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()

The tags of this scraper.

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:

The tags of this scraper.

statusReason

public final String statusReason()

The reason for failure if any.

Returns:

The reason for failure if any.

source

public final Source source()

The source that the scraper is discovering and collecting metrics from.

Returns:

The source that the scraper is discovering and collecting metrics from.

destination

public final Destination destination()

The destination that the scraper is producing metrics to.

Returns:

The destination that the scraper is producing metrics to.

toBuilder

public ScraperSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScraperSummary.Builder,ScraperSummary>

builder

public static ScraperSummary.Builder builder()

serializableBuilderClass

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