Package software.amazon.awssdk.services.opensearch.model

Class VpcEndpoint

java.lang.Object

software.amazon.awssdk.services.opensearch.model.VpcEndpoint

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<VpcEndpoint.Builder,VpcEndpoint>

@Generated("software.amazon.awssdk:codegen")
public final class VpcEndpoint
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<VpcEndpoint.Builder,VpcEndpoint>

The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VpcEndpoint.Builder

Method Summary

Modifier and Type	Method	Description
static VpcEndpoint.Builder	builder()
String	domainArn()	The Amazon Resource Name (ARN) of the domain associated with the endpoint.
String	endpoint()	The connection endpoint ID for connecting to the domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends VpcEndpoint.Builder>	serializableBuilderClass()
VpcEndpointStatus	status()	The current status of the endpoint.
String	statusAsString()	The current status of the endpoint.
VpcEndpoint.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	vpcEndpointId()	The unique identifier of the endpoint.
String	vpcEndpointOwner()	The creator of the endpoint.
VPCDerivedInfo	vpcOptions()	Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

vpcEndpointId

public final String vpcEndpointId()

The unique identifier of the endpoint.

Returns:

The unique identifier of the endpoint.

vpcEndpointOwner

public final String vpcEndpointOwner()

The creator of the endpoint.

Returns:

The creator of the endpoint.

domainArn

public final String domainArn()

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

Returns:

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

vpcOptions

public final VPCDerivedInfo vpcOptions()

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

Returns:

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

status

public final VpcEndpointStatus status()

The current status of the endpoint.

If the service returns an enum value that is not available in the current SDK version, status will return VpcEndpointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current status of the endpoint.

See Also:

VpcEndpointStatus

statusAsString

public final String statusAsString()

The current status of the endpoint.

If the service returns an enum value that is not available in the current SDK version, status will return VpcEndpointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current status of the endpoint.

See Also:

VpcEndpointStatus

endpoint

public final String endpoint()

The connection endpoint ID for connecting to the domain.

Returns:

The connection endpoint ID for connecting to the domain.

toBuilder

public VpcEndpoint.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VpcEndpoint.Builder,VpcEndpoint>

builder

public static VpcEndpoint.Builder builder()

serializableBuilderClass

public static Class<? extends VpcEndpoint.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo