software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest Maven / Gradle / Ivy
Show all versions of servicediscovery 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.servicediscovery.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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListOperationsRequest extends ServiceDiscoveryRequest implements
ToCopyableBuilder {
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListOperationsRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(ListOperationsRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(ListOperationsRequest::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filters").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(OperationFilter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NEXT_TOKEN_FIELD,
MAX_RESULTS_FIELD, FILTERS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String nextToken;
private final Integer maxResults;
private final List filters;
private ListOperationsRequest(BuilderImpl builder) {
super(builder);
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
this.filters = builder.filters;
}
/**
*
* For the first ListOperations request, omit this value.
*
*
* If the response contains NextToken, submit another ListOperations request to get the
* next group of results. Specify the value of NextToken from the previous response in the next
* request.
*
*
*
* Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's
* possible that no operations in the first MaxResults operations matched the specified criteria but
* that subsequent groups of MaxResults operations do contain operations that match the criteria.
*
*
*
* @return For the first ListOperations request, omit this value.
*
* If the response contains NextToken, submit another ListOperations request to
* get the next group of results. Specify the value of NextToken from the previous response in
* the next request.
*
*
*
* Cloud Map gets MaxResults operations and then filters them based on the specified criteria.
* It's possible that no operations in the first MaxResults operations matched the specified
* criteria but that subsequent groups of MaxResults operations do contain operations that
* match the criteria.
*
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of items that you want Cloud Map to return in the response to a ListOperations
* request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 operations.
*
*
* @return The maximum number of items that you want Cloud Map to return in the response to a
* ListOperations request. If you don't specify a value for MaxResults, Cloud Map
* returns up to 100 operations.
*/
public final Integer maxResults() {
return maxResults;
}
/**
* 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 SdkAutoConstructList);
}
/**
*
* A complex type that contains specifications for the operations that you want to list, for example, operations
* that you started between a specified start date and end date.
*
*
* If you specify more than one filter, an operation must match all filters to be returned by
* ListOperations.
*
*
* 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 A complex type that contains specifications for the operations that you want to list, for example,
* operations that you started between a specified start date and end date.
*
* If you specify more than one filter, an operation must match all filters to be returned by
* ListOperations.
*/
public final List filters() {
return filters;
}
@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(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(hasFilters() ? filters() : null);
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 ListOperationsRequest)) {
return false;
}
ListOperationsRequest other = (ListOperationsRequest) obj;
return Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults())
&& hasFilters() == other.hasFilters() && Objects.equals(filters(), other.filters());
}
/**
* 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("ListOperationsRequest").add("NextToken", nextToken()).add("MaxResults", maxResults())
.add("Filters", hasFilters() ? filters() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("NextToken", NEXT_TOKEN_FIELD);
map.put("MaxResults", MAX_RESULTS_FIELD);
map.put("Filters", FILTERS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((ListOperationsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ServiceDiscoveryRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* For the first ListOperations request, omit this value.
*
*
* If the response contains NextToken, submit another ListOperations request to get
* the next group of results. Specify the value of NextToken from the previous response in the next
* request.
*
*
*
* Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's
* possible that no operations in the first MaxResults operations matched the specified criteria
* but that subsequent groups of MaxResults operations do contain operations that match the
* criteria.
*
*
*
* @param nextToken
* For the first ListOperations request, omit this value.
*
* If the response contains NextToken, submit another ListOperations request to
* get the next group of results. Specify the value of NextToken from the previous response
* in the next request.
*
*
*
* Cloud Map gets MaxResults operations and then filters them based on the specified
* criteria. It's possible that no operations in the first MaxResults operations matched the
* specified criteria but that subsequent groups of MaxResults operations do contain
* operations that match the criteria.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of items that you want Cloud Map to return in the response to a
* ListOperations request. If you don't specify a value for MaxResults, Cloud Map
* returns up to 100 operations.
*
*
* @param maxResults
* The maximum number of items that you want Cloud Map to return in the response to a
* ListOperations request. If you don't specify a value for MaxResults, Cloud
* Map returns up to 100 operations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* A complex type that contains specifications for the operations that you want to list, for example, operations
* that you started between a specified start date and end date.
*
*
* If you specify more than one filter, an operation must match all filters to be returned by
* ListOperations.
*
*
* @param filters
* A complex type that contains specifications for the operations that you want to list, for example,
* operations that you started between a specified start date and end date.
*
* If you specify more than one filter, an operation must match all filters to be returned by
* ListOperations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Collection filters);
/**
*
* A complex type that contains specifications for the operations that you want to list, for example, operations
* that you started between a specified start date and end date.
*
*
* If you specify more than one filter, an operation must match all filters to be returned by
* ListOperations.
*
*
* @param filters
* A complex type that contains specifications for the operations that you want to list, for example,
* operations that you started between a specified start date and end date.
*
* If you specify more than one filter, an operation must match all filters to be returned by
* ListOperations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(OperationFilter... filters);
/**
*
* A complex type that contains specifications for the operations that you want to list, for example, operations
* that you started between a specified start date and end date.
*
*
* If you specify more than one filter, an operation must match all filters to be returned by
* ListOperations.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.servicediscovery.model.OperationFilter.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.servicediscovery.model.OperationFilter#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.servicediscovery.model.OperationFilter.Builder#build()} is called
* immediately and its result is passed to {@link #filters(List)}.
*
* @param filters
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.servicediscovery.model.OperationFilter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filters(java.util.Collection)
*/
Builder filters(Consumer... filters);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ServiceDiscoveryRequest.BuilderImpl implements Builder {
private String nextToken;
private Integer maxResults;
private List filters = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ListOperationsRequest model) {
super(model);
nextToken(model.nextToken);
maxResults(model.maxResults);
filters(model.filters);
}
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;
}
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 List getFilters() {
List result = OperationFiltersCopier.copyToBuilder(this.filters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFilters(Collection filters) {
this.filters = OperationFiltersCopier.copyFromBuilder(filters);
}
@Override
public final Builder filters(Collection filters) {
this.filters = OperationFiltersCopier.copy(filters);
return this;
}
@Override
@SafeVarargs
public final Builder filters(OperationFilter... filters) {
filters(Arrays.asList(filters));
return this;
}
@Override
@SafeVarargs
public final Builder filters(Consumer... filters) {
filters(Stream.of(filters).map(c -> OperationFilter.builder().applyMutation(c).build()).collect(Collectors.toList()));
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 ListOperationsRequest build() {
return new ListOperationsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}