Host (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.codestarconnections.model.Host

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Host.Builder,Host>
```
@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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Host.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Host.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- 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.
  - toBuilder
```
public Host.Builder 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 interface ToCopyableBuilder<Host.Builder,Host>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Host.Builder builder()
```
  - 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
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    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 an 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.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.61

Class Host

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

hostArn

providerType

providerTypeAsString

providerEndpoint

vpcConfiguration

status

statusMessage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields