software.amazon.awssdk.services.amp.model.WorkspaceDescription Maven / Gradle / Ivy
Show all versions of amp 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.amp.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
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 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.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The full details about one Amazon Managed Service for Prometheus workspace in your account.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class WorkspaceDescription implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ALIAS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("alias")
.getter(getter(WorkspaceDescription::alias)).setter(setter(Builder::alias))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("alias").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("arn")
.getter(getter(WorkspaceDescription::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("arn").build()).build();
private static final SdkField CREATED_AT_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("createdAt").getter(getter(WorkspaceDescription::createdAt)).setter(setter(Builder::createdAt))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("createdAt").build()).build();
private static final SdkField KMS_KEY_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("kmsKeyArn").getter(getter(WorkspaceDescription::kmsKeyArn)).setter(setter(Builder::kmsKeyArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("kmsKeyArn").build()).build();
private static final SdkField PROMETHEUS_ENDPOINT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("prometheusEndpoint").getter(getter(WorkspaceDescription::prometheusEndpoint))
.setter(setter(Builder::prometheusEndpoint))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("prometheusEndpoint").build())
.build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("status").getter(getter(WorkspaceDescription::status)).setter(setter(Builder::status))
.constructor(WorkspaceStatus::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("status").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("tags")
.getter(getter(WorkspaceDescription::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField WORKSPACE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("workspaceId").getter(getter(WorkspaceDescription::workspaceId)).setter(setter(Builder::workspaceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("workspaceId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ALIAS_FIELD, ARN_FIELD,
CREATED_AT_FIELD, KMS_KEY_ARN_FIELD, PROMETHEUS_ENDPOINT_FIELD, STATUS_FIELD, TAGS_FIELD, WORKSPACE_ID_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("alias", ALIAS_FIELD);
put("arn", ARN_FIELD);
put("createdAt", CREATED_AT_FIELD);
put("kmsKeyArn", KMS_KEY_ARN_FIELD);
put("prometheusEndpoint", PROMETHEUS_ENDPOINT_FIELD);
put("status", STATUS_FIELD);
put("tags", TAGS_FIELD);
put("workspaceId", WORKSPACE_ID_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String alias;
private final String arn;
private final Instant createdAt;
private final String kmsKeyArn;
private final String prometheusEndpoint;
private final WorkspaceStatus status;
private final Map tags;
private final String workspaceId;
private WorkspaceDescription(BuilderImpl builder) {
this.alias = builder.alias;
this.arn = builder.arn;
this.createdAt = builder.createdAt;
this.kmsKeyArn = builder.kmsKeyArn;
this.prometheusEndpoint = builder.prometheusEndpoint;
this.status = builder.status;
this.tags = builder.tags;
this.workspaceId = builder.workspaceId;
}
/**
*
* The alias that is assigned to this workspace to help identify it. It does not need to be unique.
*
*
* @return The alias that is assigned to this workspace to help identify it. It does not need to be unique.
*/
public final String alias() {
return alias;
}
/**
*
* The ARN of the workspace. For example,
* arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234.
*
*
* @return The ARN of the workspace. For example,
* arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234.
*/
public final String arn() {
return arn;
}
/**
*
* The date and time that the workspace was created.
*
*
* @return The date and time that the workspace was created.
*/
public final Instant createdAt() {
return createdAt;
}
/**
*
* (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
*
*
* @return (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
*/
public final String kmsKeyArn() {
return kmsKeyArn;
}
/**
*
* The Prometheus endpoint available for this workspace. For example,
* https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/
* .
*
*
* @return The Prometheus endpoint available for this workspace. For example,
* https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/
* .
*/
public final String prometheusEndpoint() {
return prometheusEndpoint;
}
/**
*
* The current status of the workspace.
*
*
* @return The current status of the workspace.
*/
public final WorkspaceStatus status() {
return status;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* The list of tag keys and values that are associated with the workspace.
*
*
* 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 #hasTags} method.
*
*
* @return The list of tag keys and values that are associated with the workspace.
*/
public final Map tags() {
return tags;
}
/**
*
* The unique ID for the workspace. For example, ws-example1-1234-abcd-5678-ef90abcd1234.
*
*
* @return The unique ID for the workspace. For example, ws-example1-1234-abcd-5678-ef90abcd1234.
*/
public final String workspaceId() {
return workspaceId;
}
@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 + Objects.hashCode(alias());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(createdAt());
hashCode = 31 * hashCode + Objects.hashCode(kmsKeyArn());
hashCode = 31 * hashCode + Objects.hashCode(prometheusEndpoint());
hashCode = 31 * hashCode + Objects.hashCode(status());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(workspaceId());
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 WorkspaceDescription)) {
return false;
}
WorkspaceDescription other = (WorkspaceDescription) obj;
return Objects.equals(alias(), other.alias()) && Objects.equals(arn(), other.arn())
&& Objects.equals(createdAt(), other.createdAt()) && Objects.equals(kmsKeyArn(), other.kmsKeyArn())
&& Objects.equals(prometheusEndpoint(), other.prometheusEndpoint()) && Objects.equals(status(), other.status())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags())
&& Objects.equals(workspaceId(), other.workspaceId());
}
/**
* 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("WorkspaceDescription").add("Alias", alias()).add("Arn", arn()).add("CreatedAt", createdAt())
.add("KmsKeyArn", kmsKeyArn()).add("PrometheusEndpoint", prometheusEndpoint()).add("Status", status())
.add("Tags", hasTags() ? tags() : null).add("WorkspaceId", workspaceId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "alias":
return Optional.ofNullable(clazz.cast(alias()));
case "arn":
return Optional.ofNullable(clazz.cast(arn()));
case "createdAt":
return Optional.ofNullable(clazz.cast(createdAt()));
case "kmsKeyArn":
return Optional.ofNullable(clazz.cast(kmsKeyArn()));
case "prometheusEndpoint":
return Optional.ofNullable(clazz.cast(prometheusEndpoint()));
case "status":
return Optional.ofNullable(clazz.cast(status()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
case "workspaceId":
return Optional.ofNullable(clazz.cast(workspaceId()));
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((WorkspaceDescription) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The alias that is assigned to this workspace to help identify it. It does not need to be unique.
*
*
* @param alias
* The alias that is assigned to this workspace to help identify it. It does not need to be unique.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder alias(String alias);
/**
*
* The ARN of the workspace. For example,
* arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234.
*
*
* @param arn
* The ARN of the workspace. For example,
* arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234
* .
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* The date and time that the workspace was created.
*
*
* @param createdAt
* The date and time that the workspace was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createdAt(Instant createdAt);
/**
*
* (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
*
*
* @param kmsKeyArn
* (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kmsKeyArn(String kmsKeyArn);
/**
*
* The Prometheus endpoint available for this workspace. For example,
* https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/
* .
*
*
* @param prometheusEndpoint
* The Prometheus endpoint available for this workspace. For example,
* https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/
* .
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder prometheusEndpoint(String prometheusEndpoint);
/**
*
* The current status of the workspace.
*
*
* @param status
* The current status of the workspace.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder status(WorkspaceStatus status);
/**
*
* The current status of the workspace.
*
* This is a convenience method that creates an instance of the {@link WorkspaceStatus.Builder} avoiding the
* need to create one manually via {@link WorkspaceStatus#builder()}.
*
*
* When the {@link Consumer} completes, {@link WorkspaceStatus.Builder#build()} is called immediately and its
* result is passed to {@link #status(WorkspaceStatus)}.
*
* @param status
* a consumer that will call methods on {@link WorkspaceStatus.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #status(WorkspaceStatus)
*/
default Builder status(Consumer status) {
return status(WorkspaceStatus.builder().applyMutation(status).build());
}
/**
*
* The list of tag keys and values that are associated with the workspace.
*
*
* @param tags
* The list of tag keys and values that are associated with the workspace.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
/**
*
* The unique ID for the workspace. For example, ws-example1-1234-abcd-5678-ef90abcd1234.
*
*
* @param workspaceId
* The unique ID for the workspace. For example, ws-example1-1234-abcd-5678-ef90abcd1234.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder workspaceId(String workspaceId);
}
static final class BuilderImpl implements Builder {
private String alias;
private String arn;
private Instant createdAt;
private String kmsKeyArn;
private String prometheusEndpoint;
private WorkspaceStatus status;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private String workspaceId;
private BuilderImpl() {
}
private BuilderImpl(WorkspaceDescription model) {
alias(model.alias);
arn(model.arn);
createdAt(model.createdAt);
kmsKeyArn(model.kmsKeyArn);
prometheusEndpoint(model.prometheusEndpoint);
status(model.status);
tags(model.tags);
workspaceId(model.workspaceId);
}
public final String getAlias() {
return alias;
}
public final void setAlias(String alias) {
this.alias = alias;
}
@Override
public final Builder alias(String alias) {
this.alias = alias;
return this;
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final Instant getCreatedAt() {
return createdAt;
}
public final void setCreatedAt(Instant createdAt) {
this.createdAt = createdAt;
}
@Override
public final Builder createdAt(Instant createdAt) {
this.createdAt = createdAt;
return this;
}
public final String getKmsKeyArn() {
return kmsKeyArn;
}
public final void setKmsKeyArn(String kmsKeyArn) {
this.kmsKeyArn = kmsKeyArn;
}
@Override
public final Builder kmsKeyArn(String kmsKeyArn) {
this.kmsKeyArn = kmsKeyArn;
return this;
}
public final String getPrometheusEndpoint() {
return prometheusEndpoint;
}
public final void setPrometheusEndpoint(String prometheusEndpoint) {
this.prometheusEndpoint = prometheusEndpoint;
}
@Override
public final Builder prometheusEndpoint(String prometheusEndpoint) {
this.prometheusEndpoint = prometheusEndpoint;
return this;
}
public final WorkspaceStatus.Builder getStatus() {
return status != null ? status.toBuilder() : null;
}
public final void setStatus(WorkspaceStatus.BuilderImpl status) {
this.status = status != null ? status.build() : null;
}
@Override
public final Builder status(WorkspaceStatus status) {
this.status = status;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagMapCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagMapCopier.copy(tags);
return this;
}
public final String getWorkspaceId() {
return workspaceId;
}
public final void setWorkspaceId(String workspaceId) {
this.workspaceId = workspaceId;
}
@Override
public final Builder workspaceId(String workspaceId) {
this.workspaceId = workspaceId;
return this;
}
@Override
public WorkspaceDescription build() {
return new WorkspaceDescription(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}