Class CreateScraperRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateScraperRequest.Builder,
CreateScraperRequest>
Represents the input of a CreateScraper
operation.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
alias()
(optional) a name to associate with the scraper.static CreateScraperRequest.Builder
builder()
final String
(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.final Destination
The Amazon Managed Service for Prometheus workspace to send metrics to.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final ScrapeConfiguration
The configuration file to use in the new scraper.static Class
<? extends CreateScraperRequest.Builder> final Source
source()
The Amazon EKS cluster from which the scraper will collect metrics.tags()
(Optional) The list of tag keys and values to associate with the scraper.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
alias
(optional) a name to associate with the scraper. This is for your use, and does not need to be unique.
- Returns:
- (optional) a name to associate with the scraper. This is for your use, and does not need to be unique.
-
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
The Amazon Managed Service for Prometheus workspace to send metrics to.
- Returns:
- The Amazon Managed Service for Prometheus workspace to send metrics to.
-
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
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 theisEmpty()
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
(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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateScraperRequest.Builder,
CreateScraperRequest> - Specified by:
toBuilder
in classAmpRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-