Class GatewayServiceSettings

public class GatewayServiceSettings extends ClientSettings<GatewayServiceSettings>

Settings class to configure an instance of GatewayServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (connectgateway.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getResource to 30 seconds:


 GatewayServiceSettings.Builder gatewayServiceSettingsBuilder =
     GatewayServiceSettings.newBuilder();
 gatewayServiceSettingsBuilder
     .getResourceSettings()
     .setRetrySettings(
         gatewayServiceSettingsBuilder
             .getResourceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 GatewayServiceSettings gatewayServiceSettings = gatewayServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > GatewayServiceSettings

Constructors

GatewayServiceSettings(GatewayServiceSettings.Builder settingsBuilder)

protected GatewayServiceSettings(GatewayServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderGatewayServiceSettings.Builder

Methods

create(GatewayServiceStubSettings stub)

public static final GatewayServiceSettings create(GatewayServiceStubSettings stub)
Parameter
NameDescription
stubGatewayServiceStubSettings
Returns
TypeDescription
GatewayServiceSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

deleteResourceSettings()

public UnaryCallSettings<HttpBody,HttpBody> deleteResourceSettings()

Returns the object with the settings used for calls to deleteResource.

Returns
TypeDescription
UnaryCallSettings<com.google.api.HttpBody,com.google.api.HttpBody>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

getResourceSettings()

public UnaryCallSettings<HttpBody,HttpBody> getResourceSettings()

Returns the object with the settings used for calls to getResource.

Returns
TypeDescription
UnaryCallSettings<com.google.api.HttpBody,com.google.api.HttpBody>

newBuilder()

public static GatewayServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
GatewayServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static GatewayServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
GatewayServiceSettings.Builder

patchResourceSettings()

public UnaryCallSettings<HttpBody,HttpBody> patchResourceSettings()

Returns the object with the settings used for calls to patchResource.

Returns
TypeDescription
UnaryCallSettings<com.google.api.HttpBody,com.google.api.HttpBody>

postResourceSettings()

public UnaryCallSettings<HttpBody,HttpBody> postResourceSettings()

Returns the object with the settings used for calls to postResource.

Returns
TypeDescription
UnaryCallSettings<com.google.api.HttpBody,com.google.api.HttpBody>

putResourceSettings()

public UnaryCallSettings<HttpBody,HttpBody> putResourceSettings()

Returns the object with the settings used for calls to putResource.

Returns
TypeDescription
UnaryCallSettings<com.google.api.HttpBody,com.google.api.HttpBody>

toBuilder()

public GatewayServiceSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
TypeDescription
GatewayServiceSettings.Builder
Overrides