software.amazon.awssdk.services.cleanrooms.model.Collaboration Maven / Gradle / Ivy
Show all versions of cleanrooms 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.cleanrooms.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
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.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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The multi-party data share environment. The collaboration contains metadata about its purpose and participants.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Collaboration implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("id")
.getter(getter(Collaboration::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("id").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("arn")
.getter(getter(Collaboration::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("arn").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(Collaboration::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(Collaboration::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField CREATOR_ACCOUNT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("creatorAccountId").getter(getter(Collaboration::creatorAccountId))
.setter(setter(Builder::creatorAccountId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("creatorAccountId").build()).build();
private static final SdkField CREATOR_DISPLAY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("creatorDisplayName").getter(getter(Collaboration::creatorDisplayName))
.setter(setter(Builder::creatorDisplayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("creatorDisplayName").build())
.build();
private static final SdkField CREATE_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("createTime").getter(getter(Collaboration::createTime)).setter(setter(Builder::createTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("createTime").build()).build();
private static final SdkField UPDATE_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("updateTime").getter(getter(Collaboration::updateTime)).setter(setter(Builder::updateTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("updateTime").build()).build();
private static final SdkField MEMBER_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("memberStatus").getter(getter(Collaboration::memberStatusAsString)).setter(setter(Builder::memberStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("memberStatus").build()).build();
private static final SdkField MEMBERSHIP_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("membershipId").getter(getter(Collaboration::membershipId)).setter(setter(Builder::membershipId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("membershipId").build()).build();
private static final SdkField MEMBERSHIP_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("membershipArn").getter(getter(Collaboration::membershipArn)).setter(setter(Builder::membershipArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("membershipArn").build()).build();
private static final SdkField DATA_ENCRYPTION_METADATA_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("dataEncryptionMetadata")
.getter(getter(Collaboration::dataEncryptionMetadata)).setter(setter(Builder::dataEncryptionMetadata))
.constructor(DataEncryptionMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("dataEncryptionMetadata").build())
.build();
private static final SdkField QUERY_LOG_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("queryLogStatus").getter(getter(Collaboration::queryLogStatusAsString))
.setter(setter(Builder::queryLogStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("queryLogStatus").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, ARN_FIELD,
NAME_FIELD, DESCRIPTION_FIELD, CREATOR_ACCOUNT_ID_FIELD, CREATOR_DISPLAY_NAME_FIELD, CREATE_TIME_FIELD,
UPDATE_TIME_FIELD, MEMBER_STATUS_FIELD, MEMBERSHIP_ID_FIELD, MEMBERSHIP_ARN_FIELD, DATA_ENCRYPTION_METADATA_FIELD,
QUERY_LOG_STATUS_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String arn;
private final String name;
private final String description;
private final String creatorAccountId;
private final String creatorDisplayName;
private final Instant createTime;
private final Instant updateTime;
private final String memberStatus;
private final String membershipId;
private final String membershipArn;
private final DataEncryptionMetadata dataEncryptionMetadata;
private final String queryLogStatus;
private Collaboration(BuilderImpl builder) {
this.id = builder.id;
this.arn = builder.arn;
this.name = builder.name;
this.description = builder.description;
this.creatorAccountId = builder.creatorAccountId;
this.creatorDisplayName = builder.creatorDisplayName;
this.createTime = builder.createTime;
this.updateTime = builder.updateTime;
this.memberStatus = builder.memberStatus;
this.membershipId = builder.membershipId;
this.membershipArn = builder.membershipArn;
this.dataEncryptionMetadata = builder.dataEncryptionMetadata;
this.queryLogStatus = builder.queryLogStatus;
}
/**
*
* The unique ID for the collaboration.
*
*
* @return The unique ID for the collaboration.
*/
public final String id() {
return id;
}
/**
*
* The unique ARN for the collaboration.
*
*
* @return The unique ARN for the collaboration.
*/
public final String arn() {
return arn;
}
/**
*
* A human-readable identifier provided by the collaboration owner. Display names are not unique.
*
*
* @return A human-readable identifier provided by the collaboration owner. Display names are not unique.
*/
public final String name() {
return name;
}
/**
*
* A description of the collaboration provided by the collaboration owner.
*
*
* @return A description of the collaboration provided by the collaboration owner.
*/
public final String description() {
return description;
}
/**
*
* The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services
* account ID.
*
*
* @return The identifier used to reference members of the collaboration. Currently only supports Amazon Web
* Services account ID.
*/
public final String creatorAccountId() {
return creatorAccountId;
}
/**
*
* A display name of the collaboration creator.
*
*
* @return A display name of the collaboration creator.
*/
public final String creatorDisplayName() {
return creatorDisplayName;
}
/**
*
* The time when the collaboration was created.
*
*
* @return The time when the collaboration was created.
*/
public final Instant createTime() {
return createTime;
}
/**
*
* The time the collaboration metadata was last updated.
*
*
* @return The time the collaboration metadata was last updated.
*/
public final Instant updateTime() {
return updateTime;
}
/**
*
* The status of a member in a collaboration.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #memberStatus} will
* return {@link MemberStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #memberStatusAsString}.
*
*
* @return The status of a member in a collaboration.
* @see MemberStatus
*/
public final MemberStatus memberStatus() {
return MemberStatus.fromValue(memberStatus);
}
/**
*
* The status of a member in a collaboration.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #memberStatus} will
* return {@link MemberStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #memberStatusAsString}.
*
*
* @return The status of a member in a collaboration.
* @see MemberStatus
*/
public final String memberStatusAsString() {
return memberStatus;
}
/**
*
* The unique ID for your membership within the collaboration.
*
*
* @return The unique ID for your membership within the collaboration.
*/
public final String membershipId() {
return membershipId;
}
/**
*
* The unique ARN for your membership within the collaboration.
*
*
* @return The unique ARN for your membership within the collaboration.
*/
public final String membershipArn() {
return membershipArn;
}
/**
*
* The settings for client-side encryption for cryptographic computing.
*
*
* @return The settings for client-side encryption for cryptographic computing.
*/
public final DataEncryptionMetadata dataEncryptionMetadata() {
return dataEncryptionMetadata;
}
/**
*
* An indicator as to whether query logging has been enabled or disabled for the collaboration.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #queryLogStatus}
* will return {@link CollaborationQueryLogStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #queryLogStatusAsString}.
*
*
* @return An indicator as to whether query logging has been enabled or disabled for the collaboration.
* @see CollaborationQueryLogStatus
*/
public final CollaborationQueryLogStatus queryLogStatus() {
return CollaborationQueryLogStatus.fromValue(queryLogStatus);
}
/**
*
* An indicator as to whether query logging has been enabled or disabled for the collaboration.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #queryLogStatus}
* will return {@link CollaborationQueryLogStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #queryLogStatusAsString}.
*
*
* @return An indicator as to whether query logging has been enabled or disabled for the collaboration.
* @see CollaborationQueryLogStatus
*/
public final String queryLogStatusAsString() {
return queryLogStatus;
}
@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 + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(creatorAccountId());
hashCode = 31 * hashCode + Objects.hashCode(creatorDisplayName());
hashCode = 31 * hashCode + Objects.hashCode(createTime());
hashCode = 31 * hashCode + Objects.hashCode(updateTime());
hashCode = 31 * hashCode + Objects.hashCode(memberStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(membershipId());
hashCode = 31 * hashCode + Objects.hashCode(membershipArn());
hashCode = 31 * hashCode + Objects.hashCode(dataEncryptionMetadata());
hashCode = 31 * hashCode + Objects.hashCode(queryLogStatusAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Collaboration)) {
return false;
}
Collaboration other = (Collaboration) obj;
return Objects.equals(id(), other.id()) && Objects.equals(arn(), other.arn()) && Objects.equals(name(), other.name())
&& Objects.equals(description(), other.description())
&& Objects.equals(creatorAccountId(), other.creatorAccountId())
&& Objects.equals(creatorDisplayName(), other.creatorDisplayName())
&& Objects.equals(createTime(), other.createTime()) && Objects.equals(updateTime(), other.updateTime())
&& Objects.equals(memberStatusAsString(), other.memberStatusAsString())
&& Objects.equals(membershipId(), other.membershipId()) && Objects.equals(membershipArn(), other.membershipArn())
&& Objects.equals(dataEncryptionMetadata(), other.dataEncryptionMetadata())
&& Objects.equals(queryLogStatusAsString(), other.queryLogStatusAsString());
}
/**
* 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("Collaboration").add("Id", id()).add("Arn", arn()).add("Name", name())
.add("Description", description()).add("CreatorAccountId", creatorAccountId())
.add("CreatorDisplayName", creatorDisplayName()).add("CreateTime", createTime()).add("UpdateTime", updateTime())
.add("MemberStatus", memberStatusAsString()).add("MembershipId", membershipId())
.add("MembershipArn", membershipArn()).add("DataEncryptionMetadata", dataEncryptionMetadata())
.add("QueryLogStatus", queryLogStatusAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "id":
return Optional.ofNullable(clazz.cast(id()));
case "arn":
return Optional.ofNullable(clazz.cast(arn()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "creatorAccountId":
return Optional.ofNullable(clazz.cast(creatorAccountId()));
case "creatorDisplayName":
return Optional.ofNullable(clazz.cast(creatorDisplayName()));
case "createTime":
return Optional.ofNullable(clazz.cast(createTime()));
case "updateTime":
return Optional.ofNullable(clazz.cast(updateTime()));
case "memberStatus":
return Optional.ofNullable(clazz.cast(memberStatusAsString()));
case "membershipId":
return Optional.ofNullable(clazz.cast(membershipId()));
case "membershipArn":
return Optional.ofNullable(clazz.cast(membershipArn()));
case "dataEncryptionMetadata":
return Optional.ofNullable(clazz.cast(dataEncryptionMetadata()));
case "queryLogStatus":
return Optional.ofNullable(clazz.cast(queryLogStatusAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function