Send feedback
Class EndpointContext (2.53.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.53.0 keyboard_arrow_down
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
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
getDefaultInstance()
public static EndpointContext getDefaultInstance ()
newBuilder()
public static EndpointContext . Builder newBuilder ()
Constructors
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 ()
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 ()
toBuilder()
public abstract EndpointContext . Builder toBuilder ()
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 ()
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.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-03 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2024-10-03 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-03 UTC."]]