Package software.amazon.awssdk.services.codeconnections.model

Class Host

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<Host.Builder,​Host>
    @Generated("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.

    See Also:
    Serialized Form

    • Method Detail

      • name

        public final String name()

        The name of the host.

        Returns:
        The name of the host.

      • hostArn

        public final String hostArn()

        The Amazon Resource Name (ARN) of the host.

        Returns:
        The Amazon Resource Name (ARN) of the host.

      • providerType

        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().

        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:
        ProviderType

      • providerTypeAsString

        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().

        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:
        ProviderType

      • providerEndpoint

        public final String 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

        public final VpcConfiguration vpcConfiguration()

        The VPC configuration provisioned for the host.

        Returns:
        The VPC configuration provisioned for the host.

      • status

        public final String 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

        public final String statusMessage()

        The status description for the host.

        Returns:
        The status description for the host.

      • serializableBuilderClass

        public static Class<? extends Host.Builder> serializableBuilderClass()

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String 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.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)