software.amazon.awssdk.services.ram.model.GetResourceShareAssociationsRequest Maven / Gradle / Ivy
/*
* 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.ram.model;
import java.beans.Transient;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
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.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 GetResourceShareAssociationsRequest extends RamRequest implements
ToCopyableBuilder {
private static final SdkField ASSOCIATION_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("associationType").getter(getter(GetResourceShareAssociationsRequest::associationTypeAsString))
.setter(setter(Builder::associationType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("associationType").build()).build();
private static final SdkField> RESOURCE_SHARE_ARNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("resourceShareArns")
.getter(getter(GetResourceShareAssociationsRequest::resourceShareArns))
.setter(setter(Builder::resourceShareArns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("resourceShareArns").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField RESOURCE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("resourceArn").getter(getter(GetResourceShareAssociationsRequest::resourceArn))
.setter(setter(Builder::resourceArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("resourceArn").build()).build();
private static final SdkField PRINCIPAL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("principal").getter(getter(GetResourceShareAssociationsRequest::principal))
.setter(setter(Builder::principal))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("principal").build()).build();
private static final SdkField ASSOCIATION_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("associationStatus").getter(getter(GetResourceShareAssociationsRequest::associationStatusAsString))
.setter(setter(Builder::associationStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("associationStatus").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(GetResourceShareAssociationsRequest::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(GetResourceShareAssociationsRequest::maxResults))
.setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("maxResults").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ASSOCIATION_TYPE_FIELD,
RESOURCE_SHARE_ARNS_FIELD, RESOURCE_ARN_FIELD, PRINCIPAL_FIELD, ASSOCIATION_STATUS_FIELD, NEXT_TOKEN_FIELD,
MAX_RESULTS_FIELD));
private final String associationType;
private final List resourceShareArns;
private final String resourceArn;
private final String principal;
private final String associationStatus;
private final String nextToken;
private final Integer maxResults;
private GetResourceShareAssociationsRequest(BuilderImpl builder) {
super(builder);
this.associationType = builder.associationType;
this.resourceShareArns = builder.resourceShareArns;
this.resourceArn = builder.resourceArn;
this.principal = builder.principal;
this.associationStatus = builder.associationStatus;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
*
* Specifies whether you want to retrieve the associations that involve a specified resource or principal.
*
*
* -
*
* PRINCIPAL
– list the principals that are associated with the specified resource share.
*
*
* -
*
* RESOURCE
– list the resources that are associated with the specified resource share.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #associationType}
* will return {@link ResourceShareAssociationType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #associationTypeAsString}.
*
*
* @return Specifies whether you want to retrieve the associations that involve a specified resource or
* principal.
*
* -
*
* PRINCIPAL
– list the principals that are associated with the specified resource share.
*
*
* -
*
* RESOURCE
– list the resources that are associated with the specified resource share.
*
*
* @see ResourceShareAssociationType
*/
public final ResourceShareAssociationType associationType() {
return ResourceShareAssociationType.fromValue(associationType);
}
/**
*
* Specifies whether you want to retrieve the associations that involve a specified resource or principal.
*
*
* -
*
* PRINCIPAL
– list the principals that are associated with the specified resource share.
*
*
* -
*
* RESOURCE
– list the resources that are associated with the specified resource share.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #associationType}
* will return {@link ResourceShareAssociationType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #associationTypeAsString}.
*
*
* @return Specifies whether you want to retrieve the associations that involve a specified resource or
* principal.
*
* -
*
* PRINCIPAL
– list the principals that are associated with the specified resource share.
*
*
* -
*
* RESOURCE
– list the resources that are associated with the specified resource share.
*
*
* @see ResourceShareAssociationType
*/
public final String associationTypeAsString() {
return associationType;
}
/**
* For responses, this returns true if the service returned a value for the ResourceShareArns 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 hasResourceShareArns() {
return resourceShareArns != null && !(resourceShareArns instanceof SdkAutoConstructList);
}
/**
*
* Specifies a list of Amazon
* Resource Names (ARNs) of the resource share whose associations you want to retrieve.
*
*
* 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 #hasResourceShareArns} method.
*
*
* @return Specifies a list of Amazon Resource Names
* (ARNs) of the resource share whose associations you want to retrieve.
*/
public final List resourceShareArns() {
return resourceShareArns;
}
/**
*
* Specifies the Amazon Resoure
* Name (ARN) of the resource whose resource shares you want to retrieve.
*
*
* You cannot specify this parameter if the association type is PRINCIPAL
.
*
*
* @return Specifies the Amazon
* Resoure Name (ARN) of the resource whose resource shares you want to retrieve.
*
* You cannot specify this parameter if the association type is PRINCIPAL
.
*/
public final String resourceArn() {
return resourceArn;
}
/**
*
* Specifies the ID of the principal whose resource shares you want to retrieve. This can be an Amazon Web Services
* account ID, an organization ID, an organizational unit ID, or the Amazon Resoure Name (ARN)
* of an individual IAM user or role.
*
*
* You cannot specify this parameter if the association type is RESOURCE
.
*
*
* @return Specifies the ID of the principal whose resource shares you want to retrieve. This can be an Amazon Web
* Services account ID, an organization ID, an organizational unit ID, or the Amazon Resoure Name
* (ARN) of an individual IAM user or role.
*
* You cannot specify this parameter if the association type is RESOURCE
.
*/
public final String principal() {
return principal;
}
/**
*
* Specifies that you want to retrieve only associations with this status.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #associationStatus}
* will return {@link ResourceShareAssociationStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service
* is available from {@link #associationStatusAsString}.
*
*
* @return Specifies that you want to retrieve only associations with this status.
* @see ResourceShareAssociationStatus
*/
public final ResourceShareAssociationStatus associationStatus() {
return ResourceShareAssociationStatus.fromValue(associationStatus);
}
/**
*
* Specifies that you want to retrieve only associations with this status.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #associationStatus}
* will return {@link ResourceShareAssociationStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service
* is available from {@link #associationStatusAsString}.
*
*
* @return Specifies that you want to retrieve only associations with this status.
* @see ResourceShareAssociationStatus
*/
public final String associationStatusAsString() {
return associationStatus;
}
/**
*
* Specifies that you want to receive the next page of results. Valid only if you received a NextToken
* response in the previous request. If you did, it indicates that more output is available. Set this parameter to
* the value provided by the previous call's NextToken
response to request the next page of results.
*
*
* @return Specifies that you want to receive the next page of results. Valid only if you received a
* NextToken
response in the previous request. If you did, it indicates that more output is
* available. Set this parameter to the value provided by the previous call's NextToken
* response to request the next page of results.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* Specifies the total number of results that you want included on each page of the response. If you do not include
* this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
* number you specify, the NextToken
response element is returned with a value (not null). Include the
* specified value as the NextToken
request parameter in the next call to the operation to get the next
* part of the results. Note that the service might return fewer results than the maximum even when there are more
* results available. You should check NextToken
after every operation to ensure that you receive all
* of the results.
*
*
* @return Specifies the total number of results that you want included on each page of the response. If you do not
* include this parameter, it defaults to a value that is specific to the operation. If additional items
* exist beyond the number you specify, the NextToken
response element is returned with a value
* (not null). Include the specified value as the NextToken
request parameter in the next call
* to the operation to get the next part of the results. Note that the service might return fewer results
* than the maximum even when there are more results available. You should check NextToken
* after every operation to ensure that you receive all of the results.
*/
public final Integer maxResults() {
return maxResults;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(associationTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasResourceShareArns() ? resourceShareArns() : null);
hashCode = 31 * hashCode + Objects.hashCode(resourceArn());
hashCode = 31 * hashCode + Objects.hashCode(principal());
hashCode = 31 * hashCode + Objects.hashCode(associationStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
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 GetResourceShareAssociationsRequest)) {
return false;
}
GetResourceShareAssociationsRequest other = (GetResourceShareAssociationsRequest) obj;
return Objects.equals(associationTypeAsString(), other.associationTypeAsString())
&& hasResourceShareArns() == other.hasResourceShareArns()
&& Objects.equals(resourceShareArns(), other.resourceShareArns())
&& Objects.equals(resourceArn(), other.resourceArn()) && Objects.equals(principal(), other.principal())
&& Objects.equals(associationStatusAsString(), other.associationStatusAsString())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults());
}
/**
* 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("GetResourceShareAssociationsRequest").add("AssociationType", associationTypeAsString())
.add("ResourceShareArns", hasResourceShareArns() ? resourceShareArns() : null).add("ResourceArn", resourceArn())
.add("Principal", principal()).add("AssociationStatus", associationStatusAsString())
.add("NextToken", nextToken()).add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "associationType":
return Optional.ofNullable(clazz.cast(associationTypeAsString()));
case "resourceShareArns":
return Optional.ofNullable(clazz.cast(resourceShareArns()));
case "resourceArn":
return Optional.ofNullable(clazz.cast(resourceArn()));
case "principal":
return Optional.ofNullable(clazz.cast(principal()));
case "associationStatus":
return Optional.ofNullable(clazz.cast(associationStatusAsString()));
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "maxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function