- 1.57.0 (latest)
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.6
- 1.4.0
- 1.3.2
- 1.2.12
public class ProjectsStubSettings extends StubSettings<ProjectsStubSettings>Settings class to configure an instance of ProjectsStub.
The default instance has everything set to sensible defaults:
- The default service address (cloudresourcemanager.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 getProject:
// 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
ProjectsStubSettings.Builder projectsSettingsBuilder = ProjectsStubSettings.newBuilder();
projectsSettingsBuilder
.getProjectSettings()
.setRetrySettings(
projectsSettingsBuilder
.getProjectSettings()
.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());
ProjectsStubSettings projectsSettings = projectsSettingsBuilder.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 createProject:
// 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
ProjectsStubSettings.Builder projectsSettingsBuilder = ProjectsStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
projectsSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
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 ProjectsStubSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
ProjectsStubSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static ProjectsStubSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
ProjectsStubSettings.Builder |
|
newHttpJsonBuilder()
public static ProjectsStubSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
ProjectsStubSettings.Builder |
|
Constructors
ProjectsStubSettings(ProjectsStubSettings.Builder settingsBuilder)
protected ProjectsStubSettings(ProjectsStubSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
ProjectsStubSettings.Builder |
Methods
createProjectOperationSettings()
public OperationCallSettings<CreateProjectRequest,Project,CreateProjectMetadata> createProjectOperationSettings()Returns the object with the settings used for calls to createProject.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateProjectRequest,Project,CreateProjectMetadata> |
|
createProjectSettings()
public UnaryCallSettings<CreateProjectRequest,Operation> createProjectSettings()Returns the object with the settings used for calls to createProject.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateProjectRequest,Operation> |
|
createStub()
public ProjectsStub createStub()| Returns | |
|---|---|
| Type | Description |
ProjectsStub |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
deleteProjectOperationSettings()
public OperationCallSettings<DeleteProjectRequest,Project,DeleteProjectMetadata> deleteProjectOperationSettings()Returns the object with the settings used for calls to deleteProject.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteProjectRequest,Project,DeleteProjectMetadata> |
|
deleteProjectSettings()
public UnaryCallSettings<DeleteProjectRequest,Operation> deleteProjectSettings()Returns the object with the settings used for calls to deleteProject.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteProjectRequest,Operation> |
|
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> |
|
getProjectSettings()
public UnaryCallSettings<GetProjectRequest,Project> getProjectSettings()Returns the object with the settings used for calls to getProject.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetProjectRequest,Project> |
|
getServiceName()
public String getServiceName()Returns the default service name.
| Returns | |
|---|---|
| Type | Description |
String |
|
listProjectsSettings()
public PagedCallSettings<ListProjectsRequest,ListProjectsResponse,ProjectsClient.ListProjectsPagedResponse> listProjectsSettings()Returns the object with the settings used for calls to listProjects.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListProjectsRequest,ListProjectsResponse,ListProjectsPagedResponse> |
|
moveProjectOperationSettings()
public OperationCallSettings<MoveProjectRequest,Project,MoveProjectMetadata> moveProjectOperationSettings()Returns the object with the settings used for calls to moveProject.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<MoveProjectRequest,Project,MoveProjectMetadata> |
|
moveProjectSettings()
public UnaryCallSettings<MoveProjectRequest,Operation> moveProjectSettings()Returns the object with the settings used for calls to moveProject.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<MoveProjectRequest,Operation> |
|
searchProjectsSettings()
public PagedCallSettings<SearchProjectsRequest,SearchProjectsResponse,ProjectsClient.SearchProjectsPagedResponse> searchProjectsSettings()Returns the object with the settings used for calls to searchProjects.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<SearchProjectsRequest,SearchProjectsResponse,SearchProjectsPagedResponse> |
|
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> |
|
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 ProjectsStubSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
ProjectsStubSettings.Builder |
|
undeleteProjectOperationSettings()
public OperationCallSettings<UndeleteProjectRequest,Project,UndeleteProjectMetadata> undeleteProjectOperationSettings()Returns the object with the settings used for calls to undeleteProject.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UndeleteProjectRequest,Project,UndeleteProjectMetadata> |
|
undeleteProjectSettings()
public UnaryCallSettings<UndeleteProjectRequest,Operation> undeleteProjectSettings()Returns the object with the settings used for calls to undeleteProject.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UndeleteProjectRequest,Operation> |
|
updateProjectOperationSettings()
public OperationCallSettings<UpdateProjectRequest,Project,UpdateProjectMetadata> updateProjectOperationSettings()Returns the object with the settings used for calls to updateProject.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateProjectRequest,Project,UpdateProjectMetadata> |
|
updateProjectSettings()
public UnaryCallSettings<UpdateProjectRequest,Operation> updateProjectSettings()Returns the object with the settings used for calls to updateProject.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateProjectRequest,Operation> |
|