@Generated(value="software.amazon.awssdk:codegen") public final class Host extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Host.Builder,Host>
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.
Modifier and Type | Class and Description |
---|---|
static interface |
Host.Builder |
Modifier and Type | Method and Description |
---|---|
static Host.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
hostArn()
The Amazon Resource Name (ARN) of the host.
|
String |
name()
The name of the host.
|
String |
providerEndpoint()
The endpoint of the infrastructure where your provider type is installed.
|
ProviderType |
providerType()
The name of the installed provider to be associated with your connection.
|
String |
providerTypeAsString()
The name of the installed provider to be associated with your connection.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends Host.Builder> |
serializableBuilderClass() |
String |
status()
The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and
VPC_CONFIG_FAILED_INITIALIZATION.
|
String |
statusMessage()
The status description for the host.
|
Host.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
VpcConfiguration |
vpcConfiguration()
The VPC configuration provisioned for the host.
|
copy
public final String name()
The name of the host.
public final String hostArn()
The Amazon Resource Name (ARN) of the host.
public final ProviderType 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, providerType
will
return ProviderType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
providerTypeAsString()
.
ProviderType
public final String providerTypeAsString()
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, providerType
will
return ProviderType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
providerTypeAsString()
.
ProviderType
public final String providerEndpoint()
The endpoint of the infrastructure where your provider type is installed.
public final VpcConfiguration vpcConfiguration()
The VPC configuration provisioned for the host.
public final String status()
The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.
public final String statusMessage()
The status description for the host.
public Host.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Host.Builder,Host>
public static Host.Builder builder()
public static Class<? extends Host.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.