Class DeveloperConnectStubSettings (0.8.0) 

public class DeveloperConnectStubSettings extends StubSettings<DeveloperConnectStubSettings>

Settings class to configure an instance of DeveloperConnectStub.

The default instance has everything set to sensible defaults:

  • The default service address (developerconnect.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 RetrySettings of getConnection:


 // 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
 DeveloperConnectStubSettings.Builder developerConnectSettingsBuilder =
     DeveloperConnectStubSettings.newBuilder();
 developerConnectSettingsBuilder
     .getConnectionSettings()
     .setRetrySettings(
         developerConnectSettingsBuilder
             .getConnectionSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 DeveloperConnectStubSettings developerConnectSettings = developerConnectSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createConnection:


 // 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
 DeveloperConnectStubSettings.Builder developerConnectSettingsBuilder =
     DeveloperConnectStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 developerConnectSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > StubSettings > DeveloperConnectStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static DeveloperConnectStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
DeveloperConnectStubSettings.Builder

newBuilder(ClientContext clientContext)

public static DeveloperConnectStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
DeveloperConnectStubSettings.Builder

newHttpJsonBuilder()

public static DeveloperConnectStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
DeveloperConnectStubSettings.Builder

Constructors

DeveloperConnectStubSettings(DeveloperConnectStubSettings.Builder settingsBuilder)

protected DeveloperConnectStubSettings(DeveloperConnectStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder DeveloperConnectStubSettings.Builder

Methods

createConnectionOperationSettings()

public OperationCallSettings<CreateConnectionRequest,Connection,OperationMetadata> createConnectionOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateConnectionRequest,Connection,OperationMetadata>

createConnectionSettings()

public UnaryCallSettings<CreateConnectionRequest,Operation> createConnectionSettings()

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

Returns
Type Description
UnaryCallSettings<CreateConnectionRequest,Operation>

createGitRepositoryLinkOperationSettings()

public OperationCallSettings<CreateGitRepositoryLinkRequest,GitRepositoryLink,OperationMetadata> createGitRepositoryLinkOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateGitRepositoryLinkRequest,GitRepositoryLink,OperationMetadata>

createGitRepositoryLinkSettings()

public UnaryCallSettings<CreateGitRepositoryLinkRequest,Operation> createGitRepositoryLinkSettings()

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

Returns
Type Description
UnaryCallSettings<CreateGitRepositoryLinkRequest,Operation>

createStub()

public DeveloperConnectStub createStub()
Returns
Type Description
DeveloperConnectStub
Exceptions
Type Description
IOException

deleteConnectionOperationSettings()

public OperationCallSettings<DeleteConnectionRequest,Empty,OperationMetadata> deleteConnectionOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteConnectionRequest,Empty,OperationMetadata>

deleteConnectionSettings()

public UnaryCallSettings<DeleteConnectionRequest,Operation> deleteConnectionSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteConnectionRequest,Operation>

deleteGitRepositoryLinkOperationSettings()

public OperationCallSettings<DeleteGitRepositoryLinkRequest,Empty,OperationMetadata> deleteGitRepositoryLinkOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteGitRepositoryLinkRequest,Empty,OperationMetadata>

deleteGitRepositoryLinkSettings()

public UnaryCallSettings<DeleteGitRepositoryLinkRequest,Operation> deleteGitRepositoryLinkSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteGitRepositoryLinkRequest,Operation>

fetchGitHubInstallationsSettings()

public UnaryCallSettings<FetchGitHubInstallationsRequest,FetchGitHubInstallationsResponse> fetchGitHubInstallationsSettings()

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

Returns
Type Description
UnaryCallSettings<FetchGitHubInstallationsRequest,FetchGitHubInstallationsResponse>

fetchGitRefsSettings()

public PagedCallSettings<FetchGitRefsRequest,FetchGitRefsResponse,DeveloperConnectClient.FetchGitRefsPagedResponse> fetchGitRefsSettings()

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

Returns
Type Description
PagedCallSettings<FetchGitRefsRequest,FetchGitRefsResponse,FetchGitRefsPagedResponse>

fetchLinkableGitRepositoriesSettings()

public PagedCallSettings<FetchLinkableGitRepositoriesRequest,FetchLinkableGitRepositoriesResponse,DeveloperConnectClient.FetchLinkableGitRepositoriesPagedResponse> fetchLinkableGitRepositoriesSettings()

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

Returns
Type Description
PagedCallSettings<FetchLinkableGitRepositoriesRequest,FetchLinkableGitRepositoriesResponse,FetchLinkableGitRepositoriesPagedResponse>

fetchReadTokenSettings()

public UnaryCallSettings<FetchReadTokenRequest,FetchReadTokenResponse> fetchReadTokenSettings()

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

Returns
Type Description
UnaryCallSettings<FetchReadTokenRequest,FetchReadTokenResponse>

fetchReadWriteTokenSettings()

public UnaryCallSettings<FetchReadWriteTokenRequest,FetchReadWriteTokenResponse> fetchReadWriteTokenSettings()

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

Returns
Type Description
UnaryCallSettings<FetchReadWriteTokenRequest,FetchReadWriteTokenResponse>

getConnectionSettings()

public UnaryCallSettings<GetConnectionRequest,Connection> getConnectionSettings()

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

Returns
Type Description
UnaryCallSettings<GetConnectionRequest,Connection>

getGitRepositoryLinkSettings()

public UnaryCallSettings<GetGitRepositoryLinkRequest,GitRepositoryLink> getGitRepositoryLinkSettings()

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

Returns
Type Description
UnaryCallSettings<GetGitRepositoryLinkRequest,GitRepositoryLink>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

listConnectionsSettings()

public PagedCallSettings<ListConnectionsRequest,ListConnectionsResponse,DeveloperConnectClient.ListConnectionsPagedResponse> listConnectionsSettings()

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

Returns
Type Description
PagedCallSettings<ListConnectionsRequest,ListConnectionsResponse,ListConnectionsPagedResponse>

listGitRepositoryLinksSettings()

public PagedCallSettings<ListGitRepositoryLinksRequest,ListGitRepositoryLinksResponse,DeveloperConnectClient.ListGitRepositoryLinksPagedResponse> listGitRepositoryLinksSettings()

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

Returns
Type Description
PagedCallSettings<ListGitRepositoryLinksRequest,ListGitRepositoryLinksResponse,ListGitRepositoryLinksPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,DeveloperConnectClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

toBuilder()

public DeveloperConnectStubSettings.Builder toBuilder()

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

Returns
Type Description
DeveloperConnectStubSettings.Builder
Overrides

updateConnectionOperationSettings()

public OperationCallSettings<UpdateConnectionRequest,Connection,OperationMetadata> updateConnectionOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateConnectionRequest,Connection,OperationMetadata>

updateConnectionSettings()

public UnaryCallSettings<UpdateConnectionRequest,Operation> updateConnectionSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateConnectionRequest,Operation>