Package com.google.api.gax.rpc

Class EndpointContext

java.lang.Object
com.google.api.gax.rpc.EndpointContext
@InternalApi public abstract class EndpointContext extends Object
EndpointContext is an internal class used by the client library to resolve the endpoint. It is created once the library is initialized should not be updated manually.

Contains the fields required to resolve the endpoint and Universe Domain

  • Field Details

    • GOOGLE_CLOUD_UNIVERSE_DOMAIN

      public static final String GOOGLE_CLOUD_UNIVERSE_DOMAIN
      See Also:

    • INVALID_UNIVERSE_DOMAIN_ERROR_TEMPLATE

      public static final String INVALID_UNIVERSE_DOMAIN_ERROR_TEMPLATE
      See Also:

    • UNABLE_TO_RETRIEVE_CREDENTIALS_ERROR_MESSAGE

      public static final String UNABLE_TO_RETRIEVE_CREDENTIALS_ERROR_MESSAGE
      See Also:

  • Constructor Details

    • EndpointContext

      public EndpointContext()

  • Method Details

    • getDefaultInstance

      public static EndpointContext getDefaultInstance()

    • serviceName

      @Nullable public abstract String serviceName()
      ServiceName is host URI for Google Cloud Services. It follows the format of `{ServiceName}.googleapis.com`. For example, speech.googleapis.com would have a ServiceName of speech and cloudasset.googleapis.com would have a ServiceName of cloudasset.

    • universeDomain

      @Nullable public abstract String universeDomain()
      Universe Domain is the domain for Google Cloud Services. It follows the format of `{ServiceName}.{UniverseDomain}`. For example, speech.googleapis.com would have a Universe Domain value of `googleapis.com` and cloudasset.test.com would have a Universe Domain of `test.com`. If this value is not set, this will default to `googleapis.com`.

    • clientSettingsEndpoint

      @Nullable public abstract String clientSettingsEndpoint()
      ClientSettingsEndpoint is the endpoint value set via the ClientSettings/StubSettings classes.

    • transportChannelProviderEndpoint

      @Nullable public abstract String transportChannelProviderEndpoint()
      TransportChannelProviderEndpoint is the endpoint value set via the TransportChannelProvider class.

    • mtlsEndpoint

      @Nullable public abstract String mtlsEndpoint()

    • switchToMtlsEndpointAllowed

      public abstract boolean switchToMtlsEndpointAllowed()

    • mtlsProvider

      @Nullable public abstract MtlsProvider mtlsProvider()

    • usingGDCH

      public abstract boolean usingGDCH()

    • resolvedEndpoint

      public abstract String resolvedEndpoint()

    • toBuilder

      public abstract EndpointContext.Builder toBuilder()

    • newBuilder

      public static EndpointContext.Builder newBuilder()

    • validateUniverseDomain

      public void validateUniverseDomain(com.google.auth.Credentials credentials, StatusCode invalidUniverseDomainStatusCode) throws IOException
      Check that the User configured universe domain matches the Credentials' universe domain. The status code parameter is passed in to this method as it's a limitation of Gax's modules. The transport-neutral module does have access the transport-specific modules (which contain the implementation of the StatusCode). This method is scoped to be internal and should be not be accessed by users.
      Parameters:
      credentials - Auth Library Credentials
      invalidUniverseDomainStatusCode - Transport-specific Status Code to be returned if the Universe Domain is invalid. For both transports, this is defined to be Unauthorized.
      Throws:
      IOException - Implementation of Auth's Retryable interface which tells the client library whether the RPC should be retried or not.