public class SecureSourceManagerSettings extends ClientSettings<SecureSourceManagerSettings>Settings class to configure an instance of SecureSourceManagerClient.
The default instance has everything set to sensible defaults:
- The default service address (securesourcemanager.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 getInstance:
// 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
SecureSourceManagerSettings.Builder secureSourceManagerSettingsBuilder =
SecureSourceManagerSettings.newBuilder();
secureSourceManagerSettingsBuilder
.getInstanceSettings()
.setRetrySettings(
secureSourceManagerSettingsBuilder
.getInstanceSettings()
.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());
SecureSourceManagerSettings secureSourceManagerSettings =
secureSourceManagerSettingsBuilder.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 createInstance:
// 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
SecureSourceManagerSettings.Builder secureSourceManagerSettingsBuilder =
SecureSourceManagerSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelay(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
secureSourceManagerSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
create(SecureSourceManagerStubSettings stub)
public static final SecureSourceManagerSettings create(SecureSourceManagerStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
SecureSourceManagerStubSettings |
| Returns | |
|---|---|
| Type | Description |
SecureSourceManagerSettings |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
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 |
|
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default gRPC ChannelProvider for this service.
| 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 |
|
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Returns | |
|---|---|
| Type | Description |
List<String> |
|
newBuilder()
public static SecureSourceManagerSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
SecureSourceManagerSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static SecureSourceManagerSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
SecureSourceManagerSettings.Builder |
|
newHttpJsonBuilder()
public static SecureSourceManagerSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
SecureSourceManagerSettings.Builder |
|
Constructors
SecureSourceManagerSettings(SecureSourceManagerSettings.Builder settingsBuilder)
protected SecureSourceManagerSettings(SecureSourceManagerSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
SecureSourceManagerSettings.Builder |
Methods
createBranchRuleOperationSettings()
public OperationCallSettings<CreateBranchRuleRequest,BranchRule,OperationMetadata> createBranchRuleOperationSettings()Returns the object with the settings used for calls to createBranchRule.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateBranchRuleRequest,BranchRule,OperationMetadata> |
|
createBranchRuleSettings()
public UnaryCallSettings<CreateBranchRuleRequest,Operation> createBranchRuleSettings()Returns the object with the settings used for calls to createBranchRule.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateBranchRuleRequest,Operation> |
|
createInstanceOperationSettings()
public OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationSettings()Returns the object with the settings used for calls to createInstance.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata> |
|
createInstanceSettings()
public UnaryCallSettings<CreateInstanceRequest,Operation> createInstanceSettings()Returns the object with the settings used for calls to createInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateInstanceRequest,Operation> |
|
createRepositoryOperationSettings()
public OperationCallSettings<CreateRepositoryRequest,Repository,OperationMetadata> createRepositoryOperationSettings()Returns the object with the settings used for calls to createRepository.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateRepositoryRequest,Repository,OperationMetadata> |
|
createRepositorySettings()
public UnaryCallSettings<CreateRepositoryRequest,Operation> createRepositorySettings()Returns the object with the settings used for calls to createRepository.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateRepositoryRequest,Operation> |
|
deleteBranchRuleOperationSettings()
public OperationCallSettings<DeleteBranchRuleRequest,Empty,OperationMetadata> deleteBranchRuleOperationSettings()Returns the object with the settings used for calls to deleteBranchRule.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteBranchRuleRequest,Empty,OperationMetadata> |
|
deleteBranchRuleSettings()
public UnaryCallSettings<DeleteBranchRuleRequest,Operation> deleteBranchRuleSettings()Returns the object with the settings used for calls to deleteBranchRule.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteBranchRuleRequest,Operation> |
|
deleteInstanceOperationSettings()
public OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadata> deleteInstanceOperationSettings()Returns the object with the settings used for calls to deleteInstance.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadata> |
|
deleteInstanceSettings()
public UnaryCallSettings<DeleteInstanceRequest,Operation> deleteInstanceSettings()Returns the object with the settings used for calls to deleteInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteInstanceRequest,Operation> |
|
deleteRepositoryOperationSettings()
public OperationCallSettings<DeleteRepositoryRequest,Empty,OperationMetadata> deleteRepositoryOperationSettings()Returns the object with the settings used for calls to deleteRepository.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteRepositoryRequest,Empty,OperationMetadata> |
|
deleteRepositorySettings()
public UnaryCallSettings<DeleteRepositoryRequest,Operation> deleteRepositorySettings()Returns the object with the settings used for calls to deleteRepository.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteRepositoryRequest,Operation> |
|
getBranchRuleSettings()
public UnaryCallSettings<GetBranchRuleRequest,BranchRule> getBranchRuleSettings()Returns the object with the settings used for calls to getBranchRule.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetBranchRuleRequest,BranchRule> |
|
getIamPolicyRepoSettings()
public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicyRepoSettings()Returns the object with the settings used for calls to getIamPolicyRepo.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
|
getIamPolicySettings()
public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()Returns the object with the settings used for calls to getIamPolicy.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
|
getInstanceSettings()
public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()Returns the object with the settings used for calls to getInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetInstanceRequest,Instance> |
|
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> |
|
getRepositorySettings()
public UnaryCallSettings<GetRepositoryRequest,Repository> getRepositorySettings()Returns the object with the settings used for calls to getRepository.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetRepositoryRequest,Repository> |
|
listBranchRulesSettings()
public PagedCallSettings<ListBranchRulesRequest,ListBranchRulesResponse,SecureSourceManagerClient.ListBranchRulesPagedResponse> listBranchRulesSettings()Returns the object with the settings used for calls to listBranchRules.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListBranchRulesRequest,ListBranchRulesResponse,ListBranchRulesPagedResponse> |
|
listInstancesSettings()
public PagedCallSettings<ListInstancesRequest,ListInstancesResponse,SecureSourceManagerClient.ListInstancesPagedResponse> listInstancesSettings()Returns the object with the settings used for calls to listInstances.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse> |
|
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,SecureSourceManagerClient.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> |
|
listRepositoriesSettings()
public PagedCallSettings<ListRepositoriesRequest,ListRepositoriesResponse,SecureSourceManagerClient.ListRepositoriesPagedResponse> listRepositoriesSettings()Returns the object with the settings used for calls to listRepositories.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListRepositoriesRequest,ListRepositoriesResponse,ListRepositoriesPagedResponse> |
|
setIamPolicyRepoSettings()
public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicyRepoSettings()Returns the object with the settings used for calls to setIamPolicyRepo.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
|
setIamPolicySettings()
public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()Returns the object with the settings used for calls to setIamPolicy.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
|
testIamPermissionsRepoSettings()
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsRepoSettings()Returns the object with the settings used for calls to testIamPermissionsRepo.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
|
testIamPermissionsSettings()
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
|
toBuilder()
public SecureSourceManagerSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
SecureSourceManagerSettings.Builder |
|
updateBranchRuleOperationSettings()
public OperationCallSettings<UpdateBranchRuleRequest,BranchRule,OperationMetadata> updateBranchRuleOperationSettings()Returns the object with the settings used for calls to updateBranchRule.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateBranchRuleRequest,BranchRule,OperationMetadata> |
|
updateBranchRuleSettings()
public UnaryCallSettings<UpdateBranchRuleRequest,Operation> updateBranchRuleSettings()Returns the object with the settings used for calls to updateBranchRule.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateBranchRuleRequest,Operation> |
|