Class Host
- All Implemented Interfaces:
Serializable
,SdkPojo
,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.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Host.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
hostArn()
The Amazon Resource Name (ARN) of the host.final String
name()
The name of the host.final String
The endpoint of the infrastructure where your provider type is installed.final ProviderType
The name of the installed provider to be associated with your connection.final String
The name of the installed provider to be associated with your connection.static Class
<? extends Host.Builder> final String
status()
The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.final String
The status description for the host.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final VpcConfiguration
The VPC configuration provisioned for the host.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the host.
- Returns:
- The name of the host.
-
hostArn
The Amazon Resource Name (ARN) of the host.
- Returns:
- The Amazon Resource Name (ARN) of the host.
-
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 returnProviderType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromproviderTypeAsString()
.- Returns:
- 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 Also:
-
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 returnProviderType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromproviderTypeAsString()
.- Returns:
- 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 Also:
-
providerEndpoint
The endpoint of the infrastructure where your provider type is installed.
- Returns:
- The endpoint of the infrastructure where your provider type is installed.
-
vpcConfiguration
The VPC configuration provisioned for the host.
- Returns:
- The VPC configuration provisioned for the host.
-
status
The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.
- Returns:
- The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.
-
statusMessage
The status description for the host.
- Returns:
- The status description for the host.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Host.Builder,
Host> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
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. -
getValueForField
-
sdkFields
-