software.amazon.awssdk.services.codestarconnections.model.Host 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.codestarconnections.model;
import java.io.Serializable;
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;
/**
*
* A resource that represents the infrastructure where a third-party provider is installed. The host is used when you
* create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host
* for all connections to that provider.
*
*
*
* A host created through the CLI or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by
* setting up the host in the console.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Host implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(Host::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField HOST_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("HostArn").getter(getter(Host::hostArn)).setter(setter(Builder::hostArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HostArn").build()).build();
private static final SdkField PROVIDER_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ProviderType").getter(getter(Host::providerTypeAsString)).setter(setter(Builder::providerType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProviderType").build()).build();
private static final SdkField PROVIDER_ENDPOINT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ProviderEndpoint").getter(getter(Host::providerEndpoint)).setter(setter(Builder::providerEndpoint))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProviderEndpoint").build()).build();
private static final SdkField VPC_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("VpcConfiguration")
.getter(getter(Host::vpcConfiguration)).setter(setter(Builder::vpcConfiguration))
.constructor(VpcConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VpcConfiguration").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(Host::status)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField STATUS_MESSAGE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StatusMessage").getter(getter(Host::statusMessage)).setter(setter(Builder::statusMessage))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StatusMessage").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, HOST_ARN_FIELD,
PROVIDER_TYPE_FIELD, PROVIDER_ENDPOINT_FIELD, VPC_CONFIGURATION_FIELD, STATUS_FIELD, STATUS_MESSAGE_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final String hostArn;
private final String providerType;
private final String providerEndpoint;
private final VpcConfiguration vpcConfiguration;
private final String status;
private final String statusMessage;
private Host(BuilderImpl builder) {
this.name = builder.name;
this.hostArn = builder.hostArn;
this.providerType = builder.providerType;
this.providerEndpoint = builder.providerEndpoint;
this.vpcConfiguration = builder.vpcConfiguration;
this.status = builder.status;
this.statusMessage = builder.statusMessage;
}
/**
*
* The name of the host.
*
*
* @return The name of the host.
*/
public final String name() {
return name;
}
/**
*
* The Amazon Resource Name (ARN) of the host.
*
*
* @return The Amazon Resource Name (ARN) of the host.
*/
public final String hostArn() {
return hostArn;
}
/**
*
* The name of the installed provider to be associated with your connection. The host resource represents the
* infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #providerType} will
* return {@link ProviderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #providerTypeAsString}.
*
*
* @return The name of the installed provider to be associated with your connection. The host resource represents
* the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise
* Server.
* @see ProviderType
*/
public final ProviderType providerType() {
return ProviderType.fromValue(providerType);
}
/**
*
* The name of the installed provider to be associated with your connection. The host resource represents the
* infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #providerType} will
* return {@link ProviderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #providerTypeAsString}.
*
*
* @return The name of the installed provider to be associated with your connection. The host resource represents
* the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise
* Server.
* @see ProviderType
*/
public final String providerTypeAsString() {
return providerType;
}
/**
*
* The endpoint of the infrastructure where your provider type is installed.
*
*
* @return The endpoint of the infrastructure where your provider type is installed.
*/
public final String providerEndpoint() {
return providerEndpoint;
}
/**
*
* The VPC configuration provisioned for the host.
*
*
* @return The VPC configuration provisioned for the host.
*/
public final VpcConfiguration vpcConfiguration() {
return vpcConfiguration;
}
/**
*
* The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and
* VPC_CONFIG_FAILED_INITIALIZATION.
*
*
* @return The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and
* VPC_CONFIG_FAILED_INITIALIZATION.
*/
public final String status() {
return status;
}
/**
*
* The status description for the host.
*
*
* @return The status description for the host.
*/
public final String statusMessage() {
return statusMessage;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(hostArn());
hashCode = 31 * hashCode + Objects.hashCode(providerTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(providerEndpoint());
hashCode = 31 * hashCode + Objects.hashCode(vpcConfiguration());
hashCode = 31 * hashCode + Objects.hashCode(status());
hashCode = 31 * hashCode + Objects.hashCode(statusMessage());
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 Host)) {
return false;
}
Host other = (Host) obj;
return Objects.equals(name(), other.name()) && Objects.equals(hostArn(), other.hostArn())
&& Objects.equals(providerTypeAsString(), other.providerTypeAsString())
&& Objects.equals(providerEndpoint(), other.providerEndpoint())
&& Objects.equals(vpcConfiguration(), other.vpcConfiguration()) && Objects.equals(status(), other.status())
&& Objects.equals(statusMessage(), other.statusMessage());
}
/**
* 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("Host").add("Name", name()).add("HostArn", hostArn()).add("ProviderType", providerTypeAsString())
.add("ProviderEndpoint", providerEndpoint()).add("VpcConfiguration", vpcConfiguration()).add("Status", status())
.add("StatusMessage", statusMessage()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "HostArn":
return Optional.ofNullable(clazz.cast(hostArn()));
case "ProviderType":
return Optional.ofNullable(clazz.cast(providerTypeAsString()));
case "ProviderEndpoint":
return Optional.ofNullable(clazz.cast(providerEndpoint()));
case "VpcConfiguration":
return Optional.ofNullable(clazz.cast(vpcConfiguration()));
case "Status":
return Optional.ofNullable(clazz.cast(status()));
case "StatusMessage":
return Optional.ofNullable(clazz.cast(statusMessage()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Host) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the host.
*
*
* @param name
* The name of the host.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The Amazon Resource Name (ARN) of the host.
*
*
* @param hostArn
* The Amazon Resource Name (ARN) of the host.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder hostArn(String hostArn);
/**
*
* The name of the installed provider to be associated with your connection. The host resource represents the
* infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.
*
*
* @param providerType
* The name of the installed provider to be associated with your connection. The host resource represents
* the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise
* Server.
* @see ProviderType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProviderType
*/
Builder providerType(String providerType);
/**
*
* The name of the installed provider to be associated with your connection. The host resource represents the
* infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.
*
*
* @param providerType
* The name of the installed provider to be associated with your connection. The host resource represents
* the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise
* Server.
* @see ProviderType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProviderType
*/
Builder providerType(ProviderType providerType);
/**
*
* The endpoint of the infrastructure where your provider type is installed.
*
*
* @param providerEndpoint
* The endpoint of the infrastructure where your provider type is installed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder providerEndpoint(String providerEndpoint);
/**
*
* The VPC configuration provisioned for the host.
*
*
* @param vpcConfiguration
* The VPC configuration provisioned for the host.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vpcConfiguration(VpcConfiguration vpcConfiguration);
/**
*
* The VPC configuration provisioned for the host.
*
* This is a convenience that creates an instance of the {@link VpcConfiguration.Builder} avoiding the need to
* create one manually via {@link VpcConfiguration#builder()}.
*
* When the {@link Consumer} completes, {@link VpcConfiguration.Builder#build()} is called immediately and its
* result is passed to {@link #vpcConfiguration(VpcConfiguration)}.
*
* @param vpcConfiguration
* a consumer that will call methods on {@link VpcConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #vpcConfiguration(VpcConfiguration)
*/
default Builder vpcConfiguration(Consumer vpcConfiguration) {
return vpcConfiguration(VpcConfiguration.builder().applyMutation(vpcConfiguration).build());
}
/**
*
* The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and
* VPC_CONFIG_FAILED_INITIALIZATION.
*
*
* @param status
* The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and
* VPC_CONFIG_FAILED_INITIALIZATION.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder status(String status);
/**
*
* The status description for the host.
*
*
* @param statusMessage
* The status description for the host.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder statusMessage(String statusMessage);
}
static final class BuilderImpl implements Builder {
private String name;
private String hostArn;
private String providerType;
private String providerEndpoint;
private VpcConfiguration vpcConfiguration;
private String status;
private String statusMessage;
private BuilderImpl() {
}
private BuilderImpl(Host model) {
name(model.name);
hostArn(model.hostArn);
providerType(model.providerType);
providerEndpoint(model.providerEndpoint);
vpcConfiguration(model.vpcConfiguration);
status(model.status);
statusMessage(model.statusMessage);
}
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 String getHostArn() {
return hostArn;
}
@Override
public final Builder hostArn(String hostArn) {
this.hostArn = hostArn;
return this;
}
public final void setHostArn(String hostArn) {
this.hostArn = hostArn;
}
public final String getProviderType() {
return providerType;
}
@Override
public final Builder providerType(String providerType) {
this.providerType = providerType;
return this;
}
@Override
public final Builder providerType(ProviderType providerType) {
this.providerType(providerType == null ? null : providerType.toString());
return this;
}
public final void setProviderType(String providerType) {
this.providerType = providerType;
}
public final String getProviderEndpoint() {
return providerEndpoint;
}
@Override
public final Builder providerEndpoint(String providerEndpoint) {
this.providerEndpoint = providerEndpoint;
return this;
}
public final void setProviderEndpoint(String providerEndpoint) {
this.providerEndpoint = providerEndpoint;
}
public final VpcConfiguration.Builder getVpcConfiguration() {
return vpcConfiguration != null ? vpcConfiguration.toBuilder() : null;
}
@Override
public final Builder vpcConfiguration(VpcConfiguration vpcConfiguration) {
this.vpcConfiguration = vpcConfiguration;
return this;
}
public final void setVpcConfiguration(VpcConfiguration.BuilderImpl vpcConfiguration) {
this.vpcConfiguration = vpcConfiguration != null ? vpcConfiguration.build() : null;
}
public final String getStatus() {
return status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
public final void setStatus(String status) {
this.status = status;
}
public final String getStatusMessage() {
return statusMessage;
}
@Override
public final Builder statusMessage(String statusMessage) {
this.statusMessage = statusMessage;
return this;
}
public final void setStatusMessage(String statusMessage) {
this.statusMessage = statusMessage;
}
@Override
public Host build() {
return new Host(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy