Class VpcEndpointDetail
- java.lang.Object
-
- software.amazon.awssdk.services.opensearchserverless.model.VpcEndpointDetail
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<VpcEndpointDetail.Builder,VpcEndpointDetail>
@Generated("software.amazon.awssdk:codegen") public final class VpcEndpointDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VpcEndpointDetail.Builder,VpcEndpointDetail>
Details about an OpenSearch Serverless-managed interface endpoint.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceVpcEndpointDetail.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VpcEndpointDetail.Builderbuilder()LongcreatedDate()The date the endpoint was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfailureCode()A failure code associated with the request.StringfailureMessage()A message associated with the failure code.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasSecurityGroupIds()For responses, this returns true if the service returned a value for the SecurityGroupIds property.booleanhasSubnetIds()For responses, this returns true if the service returned a value for the SubnetIds property.Stringid()The unique identifier of the endpoint.Stringname()The name of the endpoint.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()List<String>securityGroupIds()The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.static Class<? extends VpcEndpointDetail.Builder>serializableBuilderClass()VpcEndpointStatusstatus()The current status of the endpoint.StringstatusAsString()The current status of the endpoint.List<String>subnetIds()The ID of the subnets from which you access OpenSearch Serverless.VpcEndpointDetail.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringvpcId()The ID of the VPC from which you access OpenSearch Serverless.-
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
-
createdDate
public final Long createdDate()
The date the endpoint was created.
- Returns:
- The date the endpoint was created.
-
failureCode
public final String failureCode()
A failure code associated with the request.
- Returns:
- A failure code associated with the request.
-
failureMessage
public final String failureMessage()
A message associated with the failure code.
- Returns:
- A message associated with the failure code.
-
id
public final String id()
The unique identifier of the endpoint.
- Returns:
- The unique identifier of the endpoint.
-
name
public final String name()
The name of the endpoint.
- Returns:
- The name of the endpoint.
-
hasSecurityGroupIds
public final boolean hasSecurityGroupIds()
For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
securityGroupIds
public final List<String> securityGroupIds()
The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSecurityGroupIds()method.- Returns:
- The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your 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,
statuswill returnVpcEndpointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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,
statuswill returnVpcEndpointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the endpoint.
- See Also:
VpcEndpointStatus
-
hasSubnetIds
public final boolean hasSubnetIds()
For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
subnetIds
public final List<String> subnetIds()
The ID of the subnets from which you access OpenSearch Serverless.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSubnetIds()method.- Returns:
- The ID of the subnets from which you access OpenSearch Serverless.
-
vpcId
public final String vpcId()
The ID of the VPC from which you access OpenSearch Serverless.
- Returns:
- The ID of the VPC from which you access OpenSearch Serverless.
-
toBuilder
public VpcEndpointDetail.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<VpcEndpointDetail.Builder,VpcEndpointDetail>
-
builder
public static VpcEndpointDetail.Builder builder()
-
serializableBuilderClass
public static Class<? extends VpcEndpointDetail.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-