java.lang.Object
- software.amazon.awssdk.services.amp.model.ScraperDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ScraperDescription.Builder,ScraperDescription>
```
@Generated("software.amazon.awssdk:codegen")
public final class ScraperDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScraperDescription.Builder,ScraperDescription>
```
The ScraperDescription structure contains the full details about one scraper in your account.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ScraperDescription.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`alias()`	(Optional) A name associated with the scraper.
`String`	`arn()`	The Amazon Resource Name (ARN) of the scraper.
`static ScraperDescription.Builder`	`builder()`
`Instant`	`createdAt()`	The date and time that the scraper was created.
`Destination`	`destination()`	The Amazon Managed Service for Prometheus workspace the scraper sends 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 date and time that the scraper was last modified.
`String`	`roleArn()`	The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.
`ScrapeConfiguration`	`scrapeConfiguration()`	The configuration file in use by the scraper.
`String`	`scraperId()`	The ID of the scraper.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ScraperDescription.Builder>`	`serializableBuilderClass()`
`Source`	`source()`	The Amazon EKS cluster from which the scraper collects metrics.
`ScraperStatus`	`status()`	A structure that contains the current status of the scraper.
`String`	`statusReason()`	If there is a failure, the reason for the failure.
`Map<String,String>`	`tags()`	(Optional) The list of tag keys and values associated with the scraper.
`ScraperDescription.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()
```
    (Optional) A name associated with the scraper.
    
    Returns:
    
    (Optional) A name associated with the scraper.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the scraper.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the scraper.
  - createdAt
```
public final Instant createdAt()
```
    The date and time that the scraper was created.
    
    Returns:
    
    The date and time that the scraper was created.
  - destination
```
public final Destination destination()
```
    The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
    
    Returns:
    
    The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
  - lastModifiedAt
```
public final Instant lastModifiedAt()
```
    The date and time that the scraper was last modified.
    
    Returns:
    
    The date and time that the scraper was last modified.
  - roleArn
```
public final String roleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.
  - scrapeConfiguration
```
public final ScrapeConfiguration scrapeConfiguration()
```
    The configuration file in use by the scraper.
    
    Returns:
    
    The configuration file in use by the scraper.
  - scraperId
```
public final String scraperId()
```
    The ID of the scraper.
    
    Returns:
    
    The ID of the scraper.
  - source
```
public final Source source()
```
    The Amazon EKS cluster from which the scraper collects metrics.
    
    Returns:
    
    The Amazon EKS cluster from which the scraper collects metrics.
  - status
```
public final ScraperStatus status()
```
    A structure that contains the current status of the scraper.
    
    Returns:
    
    A structure that contains the current status of the scraper.
  - statusReason
```
public final String statusReason()
```
    If there is a failure, the reason for the failure.
    
    Returns:
    
    If there is a failure, the reason for the failure.
  - 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()
```
    (Optional) The list of tag keys and values associated with the 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:
    
    (Optional) The list of tag keys and values associated with the scraper.
  - toBuilder
```
public ScraperDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ScraperDescription.Builder,ScraperDescription>
  - builder
```
public static ScraperDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ScraperDescription.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

Class ScraperDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

alias

arn

createdAt

destination

lastModifiedAt

roleArn

scrapeConfiguration

scraperId

source

status

statusReason

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields