Class Endpoint

java.lang.Object
software.amazon.awssdk.services.emrcontainers.model.Endpoint
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Endpoint.Builder,Endpoint>
@Generated("software.amazon.awssdk:codegen") public final class Endpoint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Endpoint.Builder,Endpoint>

This entity represents the endpoint that is managed by Amazon EMR on EKS.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the endpoint.

      Returns:
      The ID of the endpoint.

    • name

      public final String name()

      The name of the endpoint.

      Returns:
      The name of the endpoint.

    • arn

      public final String arn()

      The ARN of the endpoint.

      Returns:
      The ARN of the endpoint.

    • virtualClusterId

      public final String virtualClusterId()

      The ID of the endpoint's virtual cluster.

      Returns:
      The ID of the endpoint's virtual cluster.

    • type

      public final String type()

      The type of the endpoint.

      Returns:
      The type of the endpoint.

    • state

      public final EndpointState state()

      The state of the endpoint.

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

      Returns:
      The state of the endpoint.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the endpoint.

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

      Returns:
      The state of the endpoint.
      See Also:

    • releaseLabel

      public final String releaseLabel()

      The EMR release version to be used for the endpoint.

      Returns:
      The EMR release version to be used for the endpoint.

    • executionRoleArn

      public final String executionRoleArn()

      The execution role ARN of the endpoint.

      Returns:
      The execution role ARN of the endpoint.

    • certificateArn

      @Deprecated public final String certificateArn()
      Deprecated.
      Customer provided certificate-arn is deprecated and would be removed in future.

      The certificate ARN of the endpoint. This field is under deprecation and will be removed in future.

      Returns:
      The certificate ARN of the endpoint. This field is under deprecation and will be removed in future.

    • certificateAuthority

      public final Certificate certificateAuthority()

      The certificate generated by emr control plane on customer behalf to secure the managed endpoint.

      Returns:
      The certificate generated by emr control plane on customer behalf to secure the managed endpoint.

    • configurationOverrides

      public final ConfigurationOverrides configurationOverrides()

      The configuration settings that are used to override existing configurations for endpoints.

      Returns:
      The configuration settings that are used to override existing configurations for endpoints.

    • serverUrl

      public final String serverUrl()

      The server URL of the endpoint.

      Returns:
      The server URL of the endpoint.

    • createdAt

      public final Instant createdAt()

      The date and time when the endpoint was created.

      Returns:
      The date and time when the endpoint was created.

    • securityGroup

      public final String securityGroup()

      The security group configuration of the endpoint.

      Returns:
      The security group configuration of the endpoint.

    • 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 the isEmpty() 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 subnet IDs of the 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 hasSubnetIds() method.

      Returns:
      The subnet IDs of the endpoint.

    • stateDetails

      public final String stateDetails()

      Additional details of the endpoint state.

      Returns:
      Additional details of the endpoint state.

    • failureReason

      public final FailureReason failureReason()

      The reasons why the endpoint has failed.

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

      Returns:
      The reasons why the endpoint has failed.
      See Also:

    • failureReasonAsString

      public final String failureReasonAsString()

      The reasons why the endpoint has failed.

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

      Returns:
      The reasons why the endpoint has failed.
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • tags

      public final Map<String,String> tags()

      The tags of the 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 hasTags() method.

      Returns:
      The tags of the endpoint.

    • toBuilder

      public Endpoint.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<Endpoint.Builder,Endpoint>
      Returns:
      a builder for type T

    • builder

      public static Endpoint.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.