com.google.cloud.gkeconnect.gateway.v1beta1.stub

Class GatewayServiceStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<GatewayServiceStubSettings>

com.google.cloud.gkeconnect.gateway.v1beta1.stub.GatewayServiceStubSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class GatewayServiceStubSettings
extends com.google.api.gax.rpc.StubSettings<GatewayServiceStubSettings>

Settings class to configure an instance of GatewayServiceStub.

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:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 GatewayServiceStubSettings.Builder gatewayServiceSettingsBuilder =
     GatewayServiceStubSettings.newBuilder();
 gatewayServiceSettingsBuilder
     .getResourceSettings()
     .setRetrySettings(
         gatewayServiceSettingsBuilder.getResourceSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 GatewayServiceStubSettings gatewayServiceSettings = gatewayServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GatewayServiceStubSettings.Builder Builder for GatewayServiceStubSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GatewayServiceStubSettings(GatewayServiceStubSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
GatewayServiceStub	createStub()
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<com.google.api.HttpBody,com.google.api.HttpBody>	deleteResourceSettings() Returns the object with the settings used for calls to deleteResource.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<com.google.api.HttpBody,com.google.api.HttpBody>	getResourceSettings() Returns the object with the settings used for calls to getResource.
static GatewayServiceStubSettings.Builder	newBuilder() Returns a new builder for this class.
static GatewayServiceStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<com.google.api.HttpBody,com.google.api.HttpBody>	patchResourceSettings() Returns the object with the settings used for calls to patchResource.
com.google.api.gax.rpc.UnaryCallSettings<com.google.api.HttpBody,com.google.api.HttpBody>	postResourceSettings() Returns the object with the settings used for calls to postResource.
com.google.api.gax.rpc.UnaryCallSettings<com.google.api.HttpBody,com.google.api.HttpBody>	putResourceSettings() Returns the object with the settings used for calls to putResource.
GatewayServiceStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class com.google.api.gax.rpc.StubSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GatewayServiceStubSettings

protected GatewayServiceStubSettings(GatewayServiceStubSettings.Builder settingsBuilder)
                              throws IOException

Throws:

IOException

Method Detail

getResourceSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.api.HttpBody,com.google.api.HttpBody> getResourceSettings()

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

postResourceSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.api.HttpBody,com.google.api.HttpBody> postResourceSettings()

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

deleteResourceSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.api.HttpBody,com.google.api.HttpBody> deleteResourceSettings()

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

putResourceSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.api.HttpBody,com.google.api.HttpBody> putResourceSettings()

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

patchResourceSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.api.HttpBody,com.google.api.HttpBody> patchResourceSettings()

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

createStub

public GatewayServiceStub createStub()
                              throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static GatewayServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static GatewayServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public GatewayServiceStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<GatewayServiceStubSettings>