Class ConnectionServiceStubSettings (2.1.11)

public class ConnectionServiceStubSettings extends StubSettings<ConnectionServiceStubSettings>

Settings class to configure an instance of ConnectionServiceStub.

The default instance has everything set to sensible defaults:

  • The default service address (bigqueryconnection.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 createConnection to 30 seconds:


 ConnectionServiceStubSettings.Builder connectionServiceSettingsBuilder =
     ConnectionServiceStubSettings.newBuilder();
 connectionServiceSettingsBuilder
     .createConnectionSettings()
     .setRetrySettings(
         connectionServiceSettingsBuilder
             .createConnectionSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ConnectionServiceStubSettings connectionServiceSettings =
     connectionServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > ConnectionServiceStubSettings

Static Methods

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

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static ConnectionServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
ConnectionServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static ConnectionServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
ConnectionServiceStubSettings.Builder

Constructors

ConnectionServiceStubSettings(ConnectionServiceStubSettings.Builder settingsBuilder)

protected ConnectionServiceStubSettings(ConnectionServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderConnectionServiceStubSettings.Builder

Methods

createConnectionSettings()

public UnaryCallSettings<ConnectionProto.CreateConnectionRequest,ConnectionProto.Connection> createConnectionSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateConnectionRequest,Connection>

createStub()

public ConnectionServiceStub createStub()
Returns
TypeDescription
ConnectionServiceStub
Exceptions
TypeDescription
IOException

deleteConnectionSettings()

public UnaryCallSettings<ConnectionProto.DeleteConnectionRequest,Empty> deleteConnectionSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteConnectionRequest,Empty>

getConnectionSettings()

public UnaryCallSettings<ConnectionProto.GetConnectionRequest,ConnectionProto.Connection> getConnectionSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetConnectionRequest,Connection>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

listConnectionsSettings()

public UnaryCallSettings<ConnectionProto.ListConnectionsRequest,ConnectionProto.ListConnectionsResponse> listConnectionsSettings()

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

Returns
TypeDescription
UnaryCallSettings<ListConnectionsRequest,ListConnectionsResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public ConnectionServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
ConnectionServiceStubSettings.Builder
Overrides

updateConnectionCredentialSettings()

public UnaryCallSettings<ConnectionProto.UpdateConnectionCredentialRequest,Empty> updateConnectionCredentialSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateConnectionCredentialRequest,Empty>

updateConnectionSettings()

public UnaryCallSettings<ConnectionProto.UpdateConnectionRequest,ConnectionProto.Connection> updateConnectionSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateConnectionRequest,Connection>