software.amazon.awssdk.services.ec2.model.DescribeVpcEndpointServiceConfigurationsRequest Maven / Gradle / Ivy
Show all versions of ec2 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.ec2.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 DescribeVpcEndpointServiceConfigurationsRequest extends Ec2Request
implements
ToCopyableBuilder {
private static final SdkField DRY_RUN_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("DryRun")
.getter(getter(DescribeVpcEndpointServiceConfigurationsRequest::dryRun))
.setter(setter(Builder::dryRun))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DryRun")
.unmarshallLocationName("DryRun").build()).build();
private static final SdkField> SERVICE_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ServiceIds")
.getter(getter(DescribeVpcEndpointServiceConfigurationsRequest::serviceIds))
.setter(setter(Builder::serviceIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ServiceId")
.unmarshallLocationName("ServiceId").build(),
ListTrait
.builder()
.memberLocationName("item")
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Item").unmarshallLocationName("item").build()).build())
.build()).build();
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(DescribeVpcEndpointServiceConfigurationsRequest::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filter")
.unmarshallLocationName("Filter").build(),
ListTrait
.builder()
.memberLocationName("Filter")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Filter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Filter").unmarshallLocationName("Filter").build()).build())
.build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("MaxResults")
.getter(getter(DescribeVpcEndpointServiceConfigurationsRequest::maxResults))
.setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults")
.unmarshallLocationName("MaxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("NextToken")
.getter(getter(DescribeVpcEndpointServiceConfigurationsRequest::nextToken))
.setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken")
.unmarshallLocationName("NextToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DRY_RUN_FIELD,
SERVICE_IDS_FIELD, FILTERS_FIELD, MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("DryRun", DRY_RUN_FIELD);
put("ServiceId", SERVICE_IDS_FIELD);
put("Filter", FILTERS_FIELD);
put("MaxResults", MAX_RESULTS_FIELD);
put("NextToken", NEXT_TOKEN_FIELD);
}
});
private final Boolean dryRun;
private final List serviceIds;
private final List filters;
private final Integer maxResults;
private final String nextToken;
private DescribeVpcEndpointServiceConfigurationsRequest(BuilderImpl builder) {
super(builder);
this.dryRun = builder.dryRun;
this.serviceIds = builder.serviceIds;
this.filters = builder.filters;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
}
/**
*
* Checks whether you have the required permissions for the action, without actually making the request, and
* provides an error response. If you have the required permissions, the error response is
* DryRunOperation. Otherwise, it is UnauthorizedOperation.
*
*
* @return Checks whether you have the required permissions for the action, without actually making the request, and
* provides an error response. If you have the required permissions, the error response is
* DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
public final Boolean dryRun() {
return dryRun;
}
/**
* For responses, this returns true if the service returned a value for the ServiceIds 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 hasServiceIds() {
return serviceIds != null && !(serviceIds instanceof SdkAutoConstructList);
}
/**
*
* The IDs of the endpoint services.
*
*
* 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 #hasServiceIds} method.
*
*
* @return The IDs of the endpoint services.
*/
public final List serviceIds() {
return serviceIds;
}
/**
* 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);
}
/**
*
* The filters.
*
*
* -
*
* service-name - The name of the service.
*
*
* -
*
* service-id - The ID of the service.
*
*
* -
*
* service-state - The state of the service (Pending | Available |
* Deleting | Deleted | Failed).
*
*
* -
*
* supported-ip-address-types - The IP address type (ipv4 | ipv6).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
*
*
* 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 The filters.
*
* -
*
* service-name - The name of the service.
*
*
* -
*
* service-id - The ID of the service.
*
*
* -
*
* service-state - The state of the service (Pending | Available |
* Deleting | Deleted | Failed).
*
*
* -
*
* supported-ip-address-types - The IP address type (ipv4 | ipv6).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that
* have a tag with the key Owner and the value TeamA, specify
* tag:Owner for the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
*/
public final List filters() {
return filters;
}
/**
*
* The maximum number of results to return for the request in a single page. The remaining results of the initial
* request can be seen by sending another request with the returned NextToken value. This value can be
* between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are
* returned.
*
*
* @return The maximum number of results to return for the request in a single page. The remaining results of the
* initial request can be seen by sending another request with the returned NextToken value.
* This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000,
* only 1,000 results are returned.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* The token to retrieve the next page of results.
*
*
* @return The token to retrieve the next page of results.
*/
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(dryRun());
hashCode = 31 * hashCode + Objects.hashCode(hasServiceIds() ? serviceIds() : null);
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 DescribeVpcEndpointServiceConfigurationsRequest)) {
return false;
}
DescribeVpcEndpointServiceConfigurationsRequest other = (DescribeVpcEndpointServiceConfigurationsRequest) obj;
return Objects.equals(dryRun(), other.dryRun()) && hasServiceIds() == other.hasServiceIds()
&& Objects.equals(serviceIds(), other.serviceIds()) && 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("DescribeVpcEndpointServiceConfigurationsRequest").add("DryRun", dryRun())
.add("ServiceIds", hasServiceIds() ? serviceIds() : null).add("Filters", hasFilters() ? filters() : null)
.add("MaxResults", maxResults()).add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DryRun":
return Optional.ofNullable(clazz.cast(dryRun()));
case "ServiceIds":
return Optional.ofNullable(clazz.cast(serviceIds()));
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((DescribeVpcEndpointServiceConfigurationsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Ec2Request.Builder, SdkPojo,
CopyableBuilder {
/**
*
* Checks whether you have the required permissions for the action, without actually making the request, and
* provides an error response. If you have the required permissions, the error response is
* DryRunOperation. Otherwise, it is UnauthorizedOperation.
*
*
* @param dryRun
* Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is
* DryRunOperation. Otherwise, it is UnauthorizedOperation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dryRun(Boolean dryRun);
/**
*
* The IDs of the endpoint services.
*
*
* @param serviceIds
* The IDs of the endpoint services.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder serviceIds(Collection serviceIds);
/**
*
* The IDs of the endpoint services.
*
*
* @param serviceIds
* The IDs of the endpoint services.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder serviceIds(String... serviceIds);
/**
*
* The filters.
*
*
* -
*
* service-name - The name of the service.
*
*
* -
*
* service-id - The ID of the service.
*
*
* -
*
* service-state - The state of the service (Pending | Available |
* Deleting | Deleted | Failed).
*
*
* -
*
* supported-ip-address-types - The IP address type (ipv4 | ipv6).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key
* in the filter name and the tag value as the filter value. For example, to find all resources that have a tag
* with the key Owner and the value TeamA, specify tag:Owner for the
* filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* service-name - The name of the service.
*
*
* -
*
* service-id - The ID of the service.
*
*
* -
*
* service-state - The state of the service (Pending | Available |
* Deleting | Deleted | Failed).
*
*
* -
*
* supported-ip-address-types - The IP address type (ipv4 | ipv6).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the
* tag key in the filter name and the tag value as the filter value. For example, to find all resources
* that have a tag with the key Owner and the value TeamA, specify
* tag:Owner for the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all
* resources assigned a tag with a specific key, regardless of the tag value.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Collection filters);
/**
*
* The filters.
*
*
* -
*
* service-name - The name of the service.
*
*
* -
*
* service-id - The ID of the service.
*
*
* -
*
* service-state - The state of the service (Pending | Available |
* Deleting | Deleted | Failed).
*
*
* -
*
* supported-ip-address-types - The IP address type (ipv4 | ipv6).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key
* in the filter name and the tag value as the filter value. For example, to find all resources that have a tag
* with the key Owner and the value TeamA, specify tag:Owner for the
* filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* service-name - The name of the service.
*
*
* -
*
* service-id - The ID of the service.
*
*
* -
*
* service-state - The state of the service (Pending | Available |
* Deleting | Deleted | Failed).
*
*
* -
*
* supported-ip-address-types - The IP address type (ipv4 | ipv6).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the
* tag key in the filter name and the tag value as the filter value. For example, to find all resources
* that have a tag with the key Owner and the value TeamA, specify
* tag:Owner for the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all
* resources assigned a tag with a specific key, regardless of the tag value.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Filter... filters);
/**
*
* The filters.
*
*
* -
*
* service-name - The name of the service.
*
*
* -
*
* service-id - The ID of the service.
*
*
* -
*
* service-state - The state of the service (Pending | Available |
* Deleting | Deleted | Failed).
*
*
* -
*
* supported-ip-address-types - The IP address type (ipv4 | ipv6).
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key
* in the filter name and the tag value as the filter value. For example, to find all resources that have a tag
* with the key Owner and the value TeamA, specify tag:Owner for the
* filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ec2.model.Filter.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.ec2.model.Filter#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.ec2.model.Filter.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.ec2.model.Filter.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);
/**
*
* The maximum number of results to return for the request in a single page. The remaining results of the
* initial request can be seen by sending another request with the returned NextToken value. This
* value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000
* results are returned.
*
*
* @param maxResults
* The maximum number of results to return for the request in a single page. The remaining results of the
* initial request can be seen by sending another request with the returned NextToken value.
* This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000,
* only 1,000 results are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* The token to retrieve the next page of results.
*
*
* @param nextToken
* The token to retrieve the next page of results.
* @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 Ec2Request.BuilderImpl implements Builder {
private Boolean dryRun;
private List serviceIds = DefaultSdkAutoConstructList.getInstance();
private List filters = DefaultSdkAutoConstructList.getInstance();
private Integer maxResults;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(DescribeVpcEndpointServiceConfigurationsRequest model) {
super(model);
dryRun(model.dryRun);
serviceIds(model.serviceIds);
filters(model.filters);
maxResults(model.maxResults);
nextToken(model.nextToken);
}
public final Boolean getDryRun() {
return dryRun;
}
public final void setDryRun(Boolean dryRun) {
this.dryRun = dryRun;
}
@Override
public final Builder dryRun(Boolean dryRun) {
this.dryRun = dryRun;
return this;
}
public final Collection getServiceIds() {
if (serviceIds instanceof SdkAutoConstructList) {
return null;
}
return serviceIds;
}
public final void setServiceIds(Collection serviceIds) {
this.serviceIds = VpcEndpointServiceIdListCopier.copy(serviceIds);
}
@Override
public final Builder serviceIds(Collection serviceIds) {
this.serviceIds = VpcEndpointServiceIdListCopier.copy(serviceIds);
return this;
}
@Override
@SafeVarargs
public final Builder serviceIds(String... serviceIds) {
serviceIds(Arrays.asList(serviceIds));
return this;
}
public final List getFilters() {
List result = FilterListCopier.copyToBuilder(this.filters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFilters(Collection filters) {
this.filters = FilterListCopier.copyFromBuilder(filters);
}
@Override
public final Builder filters(Collection filters) {
this.filters = FilterListCopier.copy(filters);
return this;
}
@Override
@SafeVarargs
public final Builder filters(Filter... filters) {
filters(Arrays.asList(filters));
return this;
}
@Override
@SafeVarargs
public final Builder filters(Consumer... filters) {
filters(Stream.of(filters).map(c -> Filter.builder().applyMutation(c).build()).collect(Collectors.toList()));
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 DescribeVpcEndpointServiceConfigurationsRequest build() {
return new DescribeVpcEndpointServiceConfigurationsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}