software.amazon.awssdk.services.ram.model.CreateResourceShareRequest 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.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 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 CreateResourceShareRequest extends RamRequest implements
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(CreateResourceShareRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField> RESOURCE_ARNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("resourceArns")
.getter(getter(CreateResourceShareRequest::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(CreateResourceShareRequest::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> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(CreateResourceShareRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField ALLOW_EXTERNAL_PRINCIPALS_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("allowExternalPrincipals").getter(getter(CreateResourceShareRequest::allowExternalPrincipals))
.setter(setter(Builder::allowExternalPrincipals))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("allowExternalPrincipals").build())
.build();
private static final SdkField CLIENT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("clientToken").getter(getter(CreateResourceShareRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientToken").build()).build();
private static final SdkField> PERMISSION_ARNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("permissionArns")
.getter(getter(CreateResourceShareRequest::permissionArns))
.setter(setter(Builder::permissionArns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("permissionArns").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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD,
RESOURCE_ARNS_FIELD, PRINCIPALS_FIELD, TAGS_FIELD, ALLOW_EXTERNAL_PRINCIPALS_FIELD, CLIENT_TOKEN_FIELD,
PERMISSION_ARNS_FIELD));
private final String name;
private final List resourceArns;
private final List principals;
private final List tags;
private final Boolean allowExternalPrincipals;
private final String clientToken;
private final List permissionArns;
private CreateResourceShareRequest(BuilderImpl builder) {
super(builder);
this.name = builder.name;
this.resourceArns = builder.resourceArns;
this.principals = builder.principals;
this.tags = builder.tags;
this.allowExternalPrincipals = builder.allowExternalPrincipals;
this.clientToken = builder.clientToken;
this.permissionArns = builder.permissionArns;
}
/**
*
* The name of the resource share.
*
*
* @return The name of the resource share.
*/
public final String name() {
return name;
}
/**
* Returns true if the ResourceArns property was specified by the sender (it may be empty), or false if the sender
* did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasResourceArns() {
return resourceArns != null && !(resourceArns instanceof SdkAutoConstructList);
}
/**
*
* The Amazon Resource Names (ARN) of the resources to associate with the resource share.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasResourceArns()} to see if a value was sent in this field.
*
*
* @return The Amazon Resource Names (ARN) of the resources to associate with the resource share.
*/
public final List resourceArns() {
return resourceArns;
}
/**
* Returns true if the Principals property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasPrincipals() {
return principals != null && !(principals instanceof SdkAutoConstructList);
}
/**
*
* The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN of an
* OU or organization from AWS Organizations.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasPrincipals()} to see if a value was sent in this field.
*
*
* @return The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN
* of an OU or organization from AWS Organizations.
*/
public final List principals() {
return principals;
}
/**
* Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
* specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* One or more tags.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasTags()} to see if a value was sent in this field.
*
*
* @return One or more tags.
*/
public final List tags() {
return tags;
}
/**
*
* Indicates whether principals outside your AWS organization can be associated with a resource share.
*
*
* @return Indicates whether principals outside your AWS organization can be associated with a resource share.
*/
public final Boolean allowExternalPrincipals() {
return allowExternalPrincipals;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*
*
* @return A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
public final String clientToken() {
return clientToken;
}
/**
* Returns true if the PermissionArns property was specified by the sender (it may be empty), or false if the sender
* did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasPermissionArns() {
return permissionArns != null && !(permissionArns instanceof SdkAutoConstructList);
}
/**
*
* The ARNs of the permissions to associate with the resource share. If you do not specify an ARN for the
* permission, AWS RAM automatically attaches the default version of the permission for each resource type.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasPermissionArns()} to see if a value was sent in this field.
*
*
* @return The ARNs of the permissions to associate with the resource share. If you do not specify an ARN for the
* permission, AWS RAM automatically attaches the default version of the permission for each resource type.
*/
public final List permissionArns() {
return permissionArns;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(hasResourceArns() ? resourceArns() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasPrincipals() ? principals() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(allowExternalPrincipals());
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
hashCode = 31 * hashCode + Objects.hashCode(hasPermissionArns() ? permissionArns() : 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 CreateResourceShareRequest)) {
return false;
}
CreateResourceShareRequest other = (CreateResourceShareRequest) obj;
return Objects.equals(name(), other.name()) && hasResourceArns() == other.hasResourceArns()
&& Objects.equals(resourceArns(), other.resourceArns()) && hasPrincipals() == other.hasPrincipals()
&& Objects.equals(principals(), other.principals()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags())
&& Objects.equals(allowExternalPrincipals(), other.allowExternalPrincipals())
&& Objects.equals(clientToken(), other.clientToken()) && hasPermissionArns() == other.hasPermissionArns()
&& Objects.equals(permissionArns(), other.permissionArns());
}
/**
* 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("CreateResourceShareRequest").add("Name", name())
.add("ResourceArns", hasResourceArns() ? resourceArns() : null)
.add("Principals", hasPrincipals() ? principals() : null).add("Tags", hasTags() ? tags() : null)
.add("AllowExternalPrincipals", allowExternalPrincipals()).add("ClientToken", clientToken())
.add("PermissionArns", hasPermissionArns() ? permissionArns() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "resourceArns":
return Optional.ofNullable(clazz.cast(resourceArns()));
case "principals":
return Optional.ofNullable(clazz.cast(principals()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
case "allowExternalPrincipals":
return Optional.ofNullable(clazz.cast(allowExternalPrincipals()));
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "permissionArns":
return Optional.ofNullable(clazz.cast(permissionArns()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateResourceShareRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RamRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the resource share.
*
*
* @param name
* The name of the resource share.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The Amazon Resource Names (ARN) of the resources to associate with the resource share.
*
*
* @param resourceArns
* The Amazon Resource Names (ARN) of the resources to associate with the resource share.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceArns(Collection resourceArns);
/**
*
* The Amazon Resource Names (ARN) of the resources to associate with the resource share.
*
*
* @param resourceArns
* The Amazon Resource Names (ARN) of the resources to associate with the resource share.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceArns(String... resourceArns);
/**
*
* The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN of
* an OU or organization from AWS Organizations.
*
*
* @param principals
* The principals to associate with the resource share. The possible values are IDs of AWS accounts, the
* ARN of an OU or organization from AWS Organizations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder principals(Collection principals);
/**
*
* The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN of
* an OU or organization from AWS Organizations.
*
*
* @param principals
* The principals to associate with the resource share. The possible values are IDs of AWS accounts, the
* ARN of an OU or organization from AWS Organizations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder principals(String... principals);
/**
*
* One or more tags.
*
*
* @param tags
* One or more tags.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* One or more tags.
*
*
* @param tags
* One or more tags.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* One or more tags.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create
* one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(List)
*/
Builder tags(Consumer... tags);
/**
*
* Indicates whether principals outside your AWS organization can be associated with a resource share.
*
*
* @param allowExternalPrincipals
* Indicates whether principals outside your AWS organization can be associated with a resource share.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowExternalPrincipals(Boolean allowExternalPrincipals);
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*
*
* @param clientToken
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientToken(String clientToken);
/**
*
* The ARNs of the permissions to associate with the resource share. If you do not specify an ARN for the
* permission, AWS RAM automatically attaches the default version of the permission for each resource type.
*
*
* @param permissionArns
* The ARNs of the permissions to associate with the resource share. If you do not specify an ARN for the
* permission, AWS RAM automatically attaches the default version of the permission for each resource
* type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder permissionArns(Collection permissionArns);
/**
*
* The ARNs of the permissions to associate with the resource share. If you do not specify an ARN for the
* permission, AWS RAM automatically attaches the default version of the permission for each resource type.
*
*
* @param permissionArns
* The ARNs of the permissions to associate with the resource share. If you do not specify an ARN for the
* permission, AWS RAM automatically attaches the default version of the permission for each resource
* type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder permissionArns(String... permissionArns);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RamRequest.BuilderImpl implements Builder {
private String name;
private List resourceArns = DefaultSdkAutoConstructList.getInstance();
private List principals = DefaultSdkAutoConstructList.getInstance();
private List tags = DefaultSdkAutoConstructList.getInstance();
private Boolean allowExternalPrincipals;
private String clientToken;
private List permissionArns = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateResourceShareRequest model) {
super(model);
name(model.name);
resourceArns(model.resourceArns);
principals(model.principals);
tags(model.tags);
allowExternalPrincipals(model.allowExternalPrincipals);
clientToken(model.clientToken);
permissionArns(model.permissionArns);
}
public final String getName() {
return name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final void setName(String name) {
this.name = name;
}
public final Collection getResourceArns() {
if (resourceArns instanceof SdkAutoConstructList) {
return null;
}
return 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 void setResourceArns(Collection resourceArns) {
this.resourceArns = ResourceArnListCopier.copy(resourceArns);
}
public final Collection getPrincipals() {
if (principals instanceof SdkAutoConstructList) {
return null;
}
return 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 void setPrincipals(Collection principals) {
this.principals = PrincipalArnOrIdListCopier.copy(principals);
}
public final Collection getTags() {
if (tags instanceof SdkAutoConstructList) {
return null;
}
return tags != null ? tags.stream().map(Tag::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
public final Boolean getAllowExternalPrincipals() {
return allowExternalPrincipals;
}
@Override
public final Builder allowExternalPrincipals(Boolean allowExternalPrincipals) {
this.allowExternalPrincipals = allowExternalPrincipals;
return this;
}
public final void setAllowExternalPrincipals(Boolean allowExternalPrincipals) {
this.allowExternalPrincipals = allowExternalPrincipals;
}
public final String getClientToken() {
return clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
return this;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
public final Collection getPermissionArns() {
if (permissionArns instanceof SdkAutoConstructList) {
return null;
}
return permissionArns;
}
@Override
public final Builder permissionArns(Collection permissionArns) {
this.permissionArns = PermissionArnListCopier.copy(permissionArns);
return this;
}
@Override
@SafeVarargs
public final Builder permissionArns(String... permissionArns) {
permissionArns(Arrays.asList(permissionArns));
return this;
}
public final void setPermissionArns(Collection permissionArns) {
this.permissionArns = PermissionArnListCopier.copy(permissionArns);
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateResourceShareRequest build() {
return new CreateResourceShareRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy