com.google.cloud.resourcemanager.v3

Class ProjectsSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<ProjectsSettings>

com.google.cloud.resourcemanager.v3.ProjectsSettings

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

Settings class to configure an instance of ProjectsClient.

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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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
 ProjectsSettings.Builder projectsSettingsBuilder = ProjectsSettings.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());
 ProjectsSettings projectsSettings = projectsSettingsBuilder.build();
 

Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) 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
 ProjectsSettings.Builder projectsSettingsBuilder = ProjectsSettings.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();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ProjectsSettings	create(ProjectsStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateProjectRequest,Project,CreateProjectMetadata>	createProjectOperationSettings() Returns the object with the settings used for calls to createProject.
com.google.api.gax.rpc.UnaryCallSettings<CreateProjectRequest,com.google.longrunning.Operation>	createProjectSettings() Returns the object with the settings used for calls to createProject.
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 gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteProjectRequest,Project,DeleteProjectMetadata>	deleteProjectOperationSettings() Returns the object with the settings used for calls to deleteProject.
com.google.api.gax.rpc.UnaryCallSettings<DeleteProjectRequest,com.google.longrunning.Operation>	deleteProjectSettings() Returns the object with the settings used for calls to deleteProject.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<GetProjectRequest,Project>	getProjectSettings() Returns the object with the settings used for calls to getProject.
com.google.api.gax.rpc.PagedCallSettings<ListProjectsRequest,ListProjectsResponse,ProjectsClient.ListProjectsPagedResponse>	listProjectsSettings() Returns the object with the settings used for calls to listProjects.
com.google.api.gax.rpc.OperationCallSettings<MoveProjectRequest,Project,MoveProjectMetadata>	moveProjectOperationSettings() Returns the object with the settings used for calls to moveProject.
com.google.api.gax.rpc.UnaryCallSettings<MoveProjectRequest,com.google.longrunning.Operation>	moveProjectSettings() Returns the object with the settings used for calls to moveProject.
static ProjectsSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static ProjectsSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static ProjectsSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.PagedCallSettings<SearchProjectsRequest,SearchProjectsResponse,ProjectsClient.SearchProjectsPagedResponse>	searchProjectsSettings() Returns the object with the settings used for calls to searchProjects.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
ProjectsSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UndeleteProjectRequest,Project,UndeleteProjectMetadata>	undeleteProjectOperationSettings() Returns the object with the settings used for calls to undeleteProject.
com.google.api.gax.rpc.UnaryCallSettings<UndeleteProjectRequest,com.google.longrunning.Operation>	undeleteProjectSettings() Returns the object with the settings used for calls to undeleteProject.
com.google.api.gax.rpc.OperationCallSettings<UpdateProjectRequest,Project,UpdateProjectMetadata>	updateProjectOperationSettings() Returns the object with the settings used for calls to updateProject.
com.google.api.gax.rpc.UnaryCallSettings<UpdateProjectRequest,com.google.longrunning.Operation>	updateProjectSettings() Returns the object with the settings used for calls to updateProject.

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

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectsSettings

protected ProjectsSettings(ProjectsSettings.Builder settingsBuilder)
                    throws IOException

Throws:

IOException

Method Detail

getProjectSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetProjectRequest,Project> getProjectSettings()

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

listProjectsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListProjectsRequest,ListProjectsResponse,ProjectsClient.ListProjectsPagedResponse> listProjectsSettings()

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

searchProjectsSettings

public com.google.api.gax.rpc.PagedCallSettings<SearchProjectsRequest,SearchProjectsResponse,ProjectsClient.SearchProjectsPagedResponse> searchProjectsSettings()

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

createProjectSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateProjectRequest,com.google.longrunning.Operation> createProjectSettings()

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

createProjectOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateProjectRequest,Project,CreateProjectMetadata> createProjectOperationSettings()

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

updateProjectSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateProjectRequest,com.google.longrunning.Operation> updateProjectSettings()

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

updateProjectOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateProjectRequest,Project,UpdateProjectMetadata> updateProjectOperationSettings()

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

moveProjectSettings

public com.google.api.gax.rpc.UnaryCallSettings<MoveProjectRequest,com.google.longrunning.Operation> moveProjectSettings()

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

moveProjectOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<MoveProjectRequest,Project,MoveProjectMetadata> moveProjectOperationSettings()

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

deleteProjectSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteProjectRequest,com.google.longrunning.Operation> deleteProjectSettings()

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

deleteProjectOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteProjectRequest,Project,DeleteProjectMetadata> deleteProjectOperationSettings()

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

undeleteProjectSettings

public com.google.api.gax.rpc.UnaryCallSettings<UndeleteProjectRequest,com.google.longrunning.Operation> undeleteProjectSettings()

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

undeleteProjectOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UndeleteProjectRequest,Project,UndeleteProjectMetadata> undeleteProjectOperationSettings()

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

getIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

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

setIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

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

testIamPermissionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

create

public static final ProjectsSettings create(ProjectsStubSettings stub)
                                     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.

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 gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

defaultTransportChannelProvider

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

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static ProjectsSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static ProjectsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public ProjectsSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<ProjectsSettings>