Class EndpointContext (2.47.0)

public abstract class EndpointContext

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

Inheritance

java.lang.Object > EndpointContext

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

GOOGLE_CLOUD_UNIVERSE_DOMAIN

public static final String GOOGLE_CLOUD_UNIVERSE_DOMAIN

Field Value
Type	Description
`String`

INVALID_UNIVERSE_DOMAIN_ERROR_TEMPLATE

public static final String INVALID_UNIVERSE_DOMAIN_ERROR_TEMPLATE

Field Value
Type	Description
`String`

UNABLE_TO_RETRIEVE_CREDENTIALS_ERROR_MESSAGE

public static final String UNABLE_TO_RETRIEVE_CREDENTIALS_ERROR_MESSAGE

Field Value
Type	Description
`String`

Static Methods

newBuilder()

public static EndpointContext.Builder newBuilder()

Returns
Type	Description
`EndpointContext.Builder`

Constructors

EndpointContext()

public EndpointContext()

Methods

clientSettingsEndpoint()

public abstract String clientSettingsEndpoint()

ClientSettingsEndpoint is the endpoint value set via the ClientSettings/StubSettings classes.

Returns
Type	Description
`String`

mtlsEndpoint()

public abstract String mtlsEndpoint()

Returns
Type	Description
`String`

mtlsProvider()

public abstract MtlsProvider mtlsProvider()

Returns
Type	Description
`MtlsProvider`

resolvedEndpoint()

public abstract String resolvedEndpoint()

Returns
Type	Description
`String`

serviceName()

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.

Returns
Type	Description
`String`

switchToMtlsEndpointAllowed()

public abstract boolean switchToMtlsEndpointAllowed()

Returns
Type	Description
`boolean`

toBuilder()

public abstract EndpointContext.Builder toBuilder()

Returns
Type	Description
`EndpointContext.Builder`

transportChannelProviderEndpoint()

public abstract String transportChannelProviderEndpoint()

TransportChannelProviderEndpoint is the endpoint value set via the TransportChannelProvider class.

Returns
Type	Description
`String`

universeDomain()

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.

Returns
Type	Description
`String`

usingGDCH()

public abstract boolean usingGDCH()

Returns
Type	Description
`boolean`

validateUniverseDomain(Credentials credentials, StatusCode invalidUniverseDomainStatusCode)

public void validateUniverseDomain(Credentials credentials, StatusCode invalidUniverseDomainStatusCode)

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
Name	Description
`credentials`	`com.google.auth.Credentials` Auth Library Credentials
`invalidUniverseDomainStatusCode`	`StatusCode` Transport-specific Status Code to be returned if the Universe Domain is invalid. For both transports, this is defined to be Unauthorized.

Exceptions
Type	Description
`IOException`	Implementation of Auth's Retryable interface which tells the client library whether the RPC should be retried or not.