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

Class CreateScraperRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.amp.model.AmpRequest

software.amazon.awssdk.services.amp.model.CreateScraperRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateScraperRequest.Builder,CreateScraperRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateScraperRequest
extends AmpRequest
implements ToCopyableBuilder<CreateScraperRequest.Builder,CreateScraperRequest>

Represents the input of a CreateScraper operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateScraperRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	alias()	(optional) An alias to associate with the scraper.
static CreateScraperRequest.Builder	builder()
String	clientToken()	(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
Destination	destination()	The Amazon Managed Service for Prometheus workspace to send 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.
RoleConfiguration	roleConfiguration()	The scraper role configuration for the workspace.
ScrapeConfiguration	scrapeConfiguration()	The configuration file to use in the new scraper.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateScraperRequest.Builder>	serializableBuilderClass()
Source	source()	The Amazon EKS cluster from which the scraper will collect metrics.
Map<String,String>	tags()	(Optional) The list of tag keys and values to associate with the scraper.
CreateScraperRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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) An alias to associate with the scraper. This is for your use, and does not need to be unique.

Returns:

(optional) An alias to associate with the scraper. This is for your use, and does not need to be unique.

clientToken

public final String clientToken()

(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

Returns:

(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

destination

public final Destination destination()

The Amazon Managed Service for Prometheus workspace to send metrics to.

Returns:

The Amazon Managed Service for Prometheus workspace to send metrics to.

roleConfiguration

public final RoleConfiguration roleConfiguration()

The scraper role configuration for the workspace.

Returns:

The scraper role configuration for the workspace.

scrapeConfiguration

public final ScrapeConfiguration scrapeConfiguration()

The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.

Returns:

The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.

source

public final Source source()

The Amazon EKS cluster from which the scraper will collect metrics.

Returns:

The Amazon EKS cluster from which the scraper will collect metrics.

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 to associate 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 to associate with the scraper.

toBuilder

public CreateScraperRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateScraperRequest.Builder,CreateScraperRequest>

Specified by:

toBuilder in class AmpRequest

builder

public static CreateScraperRequest.Builder builder()

serializableBuilderClass

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

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo