software.amazon.awssdk.services.amp.model.ListScrapersRequest Maven / Gradle / Ivy
Show all versions of amp Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.amp.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents the input of a ListScrapers operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListScrapersRequest extends AmpRequest implements
ToCopyableBuilder {
private static final SdkField>> FILTERS_FIELD = SdkField
.>> builder(MarshallingType.MAP)
.memberName("filters")
.getter(getter(ListScrapersRequest::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("filters").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField.> builder(MarshallingType.LIST)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder()
.location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build())
.build()).build()).build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("maxResults").getter(getter(ListScrapersRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("maxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(ListScrapersRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("nextToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FILTERS_FIELD,
MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("filters", FILTERS_FIELD);
put("maxResults", MAX_RESULTS_FIELD);
put("nextToken", NEXT_TOKEN_FIELD);
}
});
private final Map> filters;
private final Integer maxResults;
private final String nextToken;
private ListScrapersRequest(BuilderImpl builder) {
super(builder);
this.filters = builder.filters;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
}
/**
* For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasFilters() {
return filters != null && !(filters instanceof SdkAutoConstructMap);
}
/**
*
* (Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include status,
* sourceArn, destinationArn, and alias.
*
*
* Filters on the same key are OR'd together, and filters on different keys are AND'd
* together. For example, status=ACTIVE&status=CREATING&alias=Test, will return all scrapers
* that have the alias Test, and are either in status ACTIVE or CREATING.
*
*
* To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus
* workspace, you would use the ARN of the workspace in a query:
*
*
* status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012
*
*
* If this is included, it filters the results to only the scrapers that match the filter.
*
*
* 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 {@link #hasFilters} method.
*
*
* @return (Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include
* status, sourceArn, destinationArn, and alias.
*
* Filters on the same key are OR'd together, and filters on different keys are
* AND'd together. For example, status=ACTIVE&status=CREATING&alias=Test,
* will return all scrapers that have the alias Test, and are either in status ACTIVE or CREATING.
*
*
* To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus
* workspace, you would use the ARN of the workspace in a query:
*
*
* status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012
*
*
* If this is included, it filters the results to only the scrapers that match the filter.
*/
public final Map> filters() {
return filters;
}
/**
*
* Optional) The maximum number of scrapers to return in one ListScrapers operation. The range is
* 1-1000.
*
*
* If you omit this parameter, the default of 100 is used.
*
*
* @return Optional) The maximum number of scrapers to return in one ListScrapers operation. The range
* is 1-1000.
*
* If you omit this parameter, the default of 100 is used.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* (Optional) The token for the next set of items to return. (You received this token from a previous call.)
*
*
* @return (Optional) The token for the next set of items to return. (You received this token from a previous call.)
*/
public final String nextToken() {
return nextToken;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(hasFilters() ? filters() : null);
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ListScrapersRequest)) {
return false;
}
ListScrapersRequest other = (ListScrapersRequest) obj;
return hasFilters() == other.hasFilters() && Objects.equals(filters(), other.filters())
&& Objects.equals(maxResults(), other.maxResults()) && Objects.equals(nextToken(), other.nextToken());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("ListScrapersRequest").add("Filters", hasFilters() ? filters() : null)
.add("MaxResults", maxResults()).add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "filters":
return Optional.ofNullable(clazz.cast(filters()));
case "maxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((ListScrapersRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends AmpRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* (Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include
* status, sourceArn, destinationArn, and alias.
*
*
* Filters on the same key are OR'd together, and filters on different keys are AND'd
* together. For example, status=ACTIVE&status=CREATING&alias=Test, will return all
* scrapers that have the alias Test, and are either in status ACTIVE or CREATING.
*
*
* To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus
* workspace, you would use the ARN of the workspace in a query:
*
*
* status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012
*
*
* If this is included, it filters the results to only the scrapers that match the filter.
*
*
* @param filters
* (Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include
* status, sourceArn, destinationArn, and alias.
*
* Filters on the same key are OR'd together, and filters on different keys are
* AND'd together. For example,
* status=ACTIVE&status=CREATING&alias=Test, will return all scrapers that have the
* alias Test, and are either in status ACTIVE or CREATING.
*
*
* To find all active scrapers that are sending metrics to a specific Amazon Managed Service for
* Prometheus workspace, you would use the ARN of the workspace in a query:
*
*
* status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012
*
*
* If this is included, it filters the results to only the scrapers that match the filter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Map> filters);
/**
*
* Optional) The maximum number of scrapers to return in one ListScrapers operation. The range is
* 1-1000.
*
*
* If you omit this parameter, the default of 100 is used.
*
*
* @param maxResults
* Optional) The maximum number of scrapers to return in one ListScrapers operation. The
* range is 1-1000.
*
* If you omit this parameter, the default of 100 is used.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* (Optional) The token for the next set of items to return. (You received this token from a previous call.)
*
*
* @param nextToken
* (Optional) The token for the next set of items to return. (You received this token from a previous
* call.)
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends AmpRequest.BuilderImpl implements Builder {
private Map> filters = DefaultSdkAutoConstructMap.getInstance();
private Integer maxResults;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(ListScrapersRequest model) {
super(model);
filters(model.filters);
maxResults(model.maxResults);
nextToken(model.nextToken);
}
public final Map> getFilters() {
if (filters instanceof SdkAutoConstructMap) {
return null;
}
return filters;
}
public final void setFilters(Map> filters) {
this.filters = ScraperFiltersCopier.copy(filters);
}
@Override
public final Builder filters(Map> filters) {
this.filters = ScraperFiltersCopier.copy(filters);
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListScrapersRequest build() {
return new ListScrapersRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}