software.amazon.awssdk.services.ram.model.DisassociateResourceShareRequest Maven / Gradle / Ivy
Show all versions of ram 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.ram.model;
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 DisassociateResourceShareRequest extends RamRequest implements
ToCopyableBuilder {
private static final SdkField RESOURCE_SHARE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("resourceShareArn").getter(getter(DisassociateResourceShareRequest::resourceShareArn))
.setter(setter(Builder::resourceShareArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("resourceShareArn").build()).build();
private static final SdkField> RESOURCE_ARNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("resourceArns")
.getter(getter(DisassociateResourceShareRequest::resourceArns))
.setter(setter(Builder::resourceArns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("resourceArns").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> PRINCIPALS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("principals")
.getter(getter(DisassociateResourceShareRequest::principals))
.setter(setter(Builder::principals))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("principals").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 CLIENT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("clientToken").getter(getter(DisassociateResourceShareRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RESOURCE_SHARE_ARN_FIELD,
RESOURCE_ARNS_FIELD, PRINCIPALS_FIELD, CLIENT_TOKEN_FIELD));
private final String resourceShareArn;
private final List resourceArns;
private final List principals;
private final String clientToken;
private DisassociateResourceShareRequest(BuilderImpl builder) {
super(builder);
this.resourceShareArn = builder.resourceShareArn;
this.resourceArns = builder.resourceArns;
this.principals = builder.principals;
this.clientToken = builder.clientToken;
}
/**
*
* Specifies Amazon Resoure
* Name (ARN) of the resource share that you want to remove resources from.
*
*
* @return Specifies Amazon
* Resoure Name (ARN) of the resource share that you want to remove resources from.
*/
public final String resourceShareArn() {
return resourceShareArn;
}
/**
* For responses, this returns true if the service returned a value for the ResourceArns 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 hasResourceArns() {
return resourceArns != null && !(resourceArns instanceof SdkAutoConstructList);
}
/**
*
* Specifies a list of Amazon
* Resource Names (ARNs) for one or more resources that you want to remove from the resource share. After the
* operation runs, these resources are no longer shared with principals outside of the Amazon Web Services account
* that created the resources.
*
*
* 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 #hasResourceArns} method.
*
*
* @return Specifies a list of Amazon Resource Names
* (ARNs) for one or more resources that you want to remove from the resource share. After the operation
* runs, these resources are no longer shared with principals outside of the Amazon Web Services account
* that created the resources.
*/
public final List resourceArns() {
return resourceArns;
}
/**
* For responses, this returns true if the service returned a value for the Principals 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 hasPrincipals() {
return principals != null && !(principals instanceof SdkAutoConstructList);
}
/**
*
* Specifies a list of one or more principals that no longer are to have access to the resources in this resource
* share.
*
*
* You can include the following values:
*
*
* -
*
* An Amazon Web Services account ID, for example: 123456789012
*
*
* -
*
* An Amazon Resoure Name
* (ARN) of an organization in Organizations, for example:
* organizations::123456789012:organization/o-exampleorgid
*
*
* -
*
* An ARN of an organizational unit (OU) in Organizations, for example:
* organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
*
*
* -
*
* An ARN of an IAM role, for example: iam::123456789012:role/rolename
*
*
* -
*
* An ARN of an IAM user, for example: iam::123456789012user/username
*
*
*
*
*
* Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
*
*
*
* 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 #hasPrincipals} method.
*
*
* @return Specifies a list of one or more principals that no longer are to have access to the resources in this
* resource share.
*
* You can include the following values:
*
*
* -
*
* An Amazon Web Services account ID, for example: 123456789012
*
*
* -
*
* An Amazon Resoure
* Name (ARN) of an organization in Organizations, for example:
* organizations::123456789012:organization/o-exampleorgid
*
*
* -
*
* An ARN of an organizational unit (OU) in Organizations, for example:
* organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
*
*
* -
*
* An ARN of an IAM role, for example: iam::123456789012:role/rolename
*
*
* -
*
* An ARN of an IAM user, for example: iam::123456789012user/username
*
*
*
*
*
* Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
*
*/
public final List principals() {
return principals;
}
/**
*
* Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This
* lets you safely retry the request without accidentally performing the same operation a second time. Passing the
* same value to a later call to an operation requires that you also pass the same value for all other parameters.
* We recommend that you use a UUID type of
* value..
*
*
* If you don't provide this value, then Amazon Web Services generates a random one for you.
*
*
* @return Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
* This lets you safely retry the request without accidentally performing the same operation a second time.
* Passing the same value to a later call to an operation requires that you also pass the same value for all
* other parameters. We recommend that you use a UUID type of value..
*
* If you don't provide this value, then Amazon Web Services generates a random one for you.
*/
public final String clientToken() {
return clientToken;
}
@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(resourceShareArn());
hashCode = 31 * hashCode + Objects.hashCode(hasResourceArns() ? resourceArns() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasPrincipals() ? principals() : null);
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
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 DisassociateResourceShareRequest)) {
return false;
}
DisassociateResourceShareRequest other = (DisassociateResourceShareRequest) obj;
return Objects.equals(resourceShareArn(), other.resourceShareArn()) && hasResourceArns() == other.hasResourceArns()
&& Objects.equals(resourceArns(), other.resourceArns()) && hasPrincipals() == other.hasPrincipals()
&& Objects.equals(principals(), other.principals()) && Objects.equals(clientToken(), other.clientToken());
}
/**
* 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("DisassociateResourceShareRequest").add("ResourceShareArn", resourceShareArn())
.add("ResourceArns", hasResourceArns() ? resourceArns() : null)
.add("Principals", hasPrincipals() ? principals() : null).add("ClientToken", clientToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "resourceShareArn":
return Optional.ofNullable(clazz.cast(resourceShareArn()));
case "resourceArns":
return Optional.ofNullable(clazz.cast(resourceArns()));
case "principals":
return Optional.ofNullable(clazz.cast(principals()));
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DisassociateResourceShareRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RamRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Specifies Amazon Resoure
* Name (ARN) of the resource share that you want to remove resources from.
*
*
* @param resourceShareArn
* Specifies Amazon
* Resoure Name (ARN) of the resource share that you want to remove resources from.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceShareArn(String resourceShareArn);
/**
*
* Specifies a list of Amazon Resource Names
* (ARNs) for one or more resources that you want to remove from the resource share. After the operation
* runs, these resources are no longer shared with principals outside of the Amazon Web Services account that
* created the resources.
*
*
* @param resourceArns
* Specifies a list of Amazon Resource
* Names (ARNs) for one or more resources that you want to remove from the resource share. After the
* operation runs, these resources are no longer shared with principals outside of the Amazon Web
* Services account that created the resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceArns(Collection resourceArns);
/**
*
* Specifies a list of Amazon Resource Names
* (ARNs) for one or more resources that you want to remove from the resource share. After the operation
* runs, these resources are no longer shared with principals outside of the Amazon Web Services account that
* created the resources.
*
*
* @param resourceArns
* Specifies a list of Amazon Resource
* Names (ARNs) for one or more resources that you want to remove from the resource share. After the
* operation runs, these resources are no longer shared with principals outside of the Amazon Web
* Services account that created the resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceArns(String... resourceArns);
/**
*
* Specifies a list of one or more principals that no longer are to have access to the resources in this
* resource share.
*
*
* You can include the following values:
*
*
* -
*
* An Amazon Web Services account ID, for example: 123456789012
*
*
* -
*
* An Amazon Resoure Name
* (ARN) of an organization in Organizations, for example:
* organizations::123456789012:organization/o-exampleorgid
*
*
* -
*
* An ARN of an organizational unit (OU) in Organizations, for example:
* organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
*
*
* -
*
* An ARN of an IAM role, for example: iam::123456789012:role/rolename
*
*
* -
*
* An ARN of an IAM user, for example: iam::123456789012user/username
*
*
*
*
*
* Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
*
*
*
* @param principals
* Specifies a list of one or more principals that no longer are to have access to the resources in this
* resource share.
*
* You can include the following values:
*
*
* -
*
* An Amazon Web Services account ID, for example: 123456789012
*
*
* -
*
* An Amazon Resoure
* Name (ARN) of an organization in Organizations, for example:
* organizations::123456789012:organization/o-exampleorgid
*
*
* -
*
* An ARN of an organizational unit (OU) in Organizations, for example:
* organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
*
*
* -
*
* An ARN of an IAM role, for example: iam::123456789012:role/rolename
*
*
* -
*
* An ARN of an IAM user, for example: iam::123456789012user/username
*
*
*
*
*
* Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder principals(Collection principals);
/**
*
* Specifies a list of one or more principals that no longer are to have access to the resources in this
* resource share.
*
*
* You can include the following values:
*
*
* -
*
* An Amazon Web Services account ID, for example: 123456789012
*
*
* -
*
* An Amazon Resoure Name
* (ARN) of an organization in Organizations, for example:
* organizations::123456789012:organization/o-exampleorgid
*
*
* -
*
* An ARN of an organizational unit (OU) in Organizations, for example:
* organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
*
*
* -
*
* An ARN of an IAM role, for example: iam::123456789012:role/rolename
*
*
* -
*
* An ARN of an IAM user, for example: iam::123456789012user/username
*
*
*
*
*
* Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
*
*
*
* @param principals
* Specifies a list of one or more principals that no longer are to have access to the resources in this
* resource share.
*
* You can include the following values:
*
*
* -
*
* An Amazon Web Services account ID, for example: 123456789012
*
*
* -
*
* An Amazon Resoure
* Name (ARN) of an organization in Organizations, for example:
* organizations::123456789012:organization/o-exampleorgid
*
*
* -
*
* An ARN of an organizational unit (OU) in Organizations, for example:
* organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
*
*
* -
*
* An ARN of an IAM role, for example: iam::123456789012:role/rolename
*
*
* -
*
* An ARN of an IAM user, for example: iam::123456789012user/username
*
*
*
*
*
* Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder principals(String... principals);
/**
*
* Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This
* lets you safely retry the request without accidentally performing the same operation a second time. Passing
* the same value to a later call to an operation requires that you also pass the same value for all other
* parameters. We recommend that you use a UUID type of value..
*
*
* If you don't provide this value, then Amazon Web Services generates a random one for you.
*
*
* @param clientToken
* Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the
* request. This lets you safely retry the request without accidentally performing the same operation a
* second time. Passing the same value to a later call to an operation requires that you also pass the
* same value for all other parameters. We recommend that you use a UUID type of value..
*
* If you don't provide this value, then Amazon Web Services generates a random one for you.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientToken(String clientToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RamRequest.BuilderImpl implements Builder {
private String resourceShareArn;
private List resourceArns = DefaultSdkAutoConstructList.getInstance();
private List principals = DefaultSdkAutoConstructList.getInstance();
private String clientToken;
private BuilderImpl() {
}
private BuilderImpl(DisassociateResourceShareRequest model) {
super(model);
resourceShareArn(model.resourceShareArn);
resourceArns(model.resourceArns);
principals(model.principals);
clientToken(model.clientToken);
}
public final String getResourceShareArn() {
return resourceShareArn;
}
public final void setResourceShareArn(String resourceShareArn) {
this.resourceShareArn = resourceShareArn;
}
@Override
public final Builder resourceShareArn(String resourceShareArn) {
this.resourceShareArn = resourceShareArn;
return this;
}
public final Collection getResourceArns() {
if (resourceArns instanceof SdkAutoConstructList) {
return null;
}
return resourceArns;
}
public final void setResourceArns(Collection resourceArns) {
this.resourceArns = ResourceArnListCopier.copy(resourceArns);
}
@Override
public final Builder resourceArns(Collection resourceArns) {
this.resourceArns = ResourceArnListCopier.copy(resourceArns);
return this;
}
@Override
@SafeVarargs
public final Builder resourceArns(String... resourceArns) {
resourceArns(Arrays.asList(resourceArns));
return this;
}
public final Collection getPrincipals() {
if (principals instanceof SdkAutoConstructList) {
return null;
}
return principals;
}
public final void setPrincipals(Collection principals) {
this.principals = PrincipalArnOrIdListCopier.copy(principals);
}
@Override
public final Builder principals(Collection principals) {
this.principals = PrincipalArnOrIdListCopier.copy(principals);
return this;
}
@Override
@SafeVarargs
public final Builder principals(String... principals) {
principals(Arrays.asList(principals));
return this;
}
public final String getClientToken() {
return clientToken;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
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 DisassociateResourceShareRequest build() {
return new DisassociateResourceShareRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}