com.google.cloud.resourcemanager.v3

Class FoldersSettings

java.lang.Object

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

com.google.cloud.resourcemanager.v3.FoldersSettings

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

Settings class to configure an instance of FoldersClient.

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 getFolder:

 // 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
 FoldersSettings.Builder foldersSettingsBuilder = FoldersSettings.newBuilder();
 foldersSettingsBuilder
     .getFolderSettings()
     .setRetrySettings(
         foldersSettingsBuilder
             .getFolderSettings()
             .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());
 FoldersSettings foldersSettings = foldersSettingsBuilder.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 createFolder:

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static FoldersSettings	create(FoldersStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateFolderRequest,Folder,CreateFolderMetadata>	createFolderOperationSettings() Returns the object with the settings used for calls to createFolder.
com.google.api.gax.rpc.UnaryCallSettings<CreateFolderRequest,com.google.longrunning.Operation>	createFolderSettings() Returns the object with the settings used for calls to createFolder.
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<DeleteFolderRequest,Folder,DeleteFolderMetadata>	deleteFolderOperationSettings() Returns the object with the settings used for calls to deleteFolder.
com.google.api.gax.rpc.UnaryCallSettings<DeleteFolderRequest,com.google.longrunning.Operation>	deleteFolderSettings() Returns the object with the settings used for calls to deleteFolder.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetFolderRequest,Folder>	getFolderSettings() Returns the object with the settings used for calls to getFolder.
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.PagedCallSettings<ListFoldersRequest,ListFoldersResponse,FoldersClient.ListFoldersPagedResponse>	listFoldersSettings() Returns the object with the settings used for calls to listFolders.
com.google.api.gax.rpc.OperationCallSettings<MoveFolderRequest,Folder,MoveFolderMetadata>	moveFolderOperationSettings() Returns the object with the settings used for calls to moveFolder.
com.google.api.gax.rpc.UnaryCallSettings<MoveFolderRequest,com.google.longrunning.Operation>	moveFolderSettings() Returns the object with the settings used for calls to moveFolder.
static FoldersSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static FoldersSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static FoldersSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.PagedCallSettings<SearchFoldersRequest,SearchFoldersResponse,FoldersClient.SearchFoldersPagedResponse>	searchFoldersSettings() Returns the object with the settings used for calls to searchFolders.
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.
FoldersSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UndeleteFolderRequest,Folder,UndeleteFolderMetadata>	undeleteFolderOperationSettings() Returns the object with the settings used for calls to undeleteFolder.
com.google.api.gax.rpc.UnaryCallSettings<UndeleteFolderRequest,com.google.longrunning.Operation>	undeleteFolderSettings() Returns the object with the settings used for calls to undeleteFolder.
com.google.api.gax.rpc.OperationCallSettings<UpdateFolderRequest,Folder,UpdateFolderMetadata>	updateFolderOperationSettings() Returns the object with the settings used for calls to updateFolder.
com.google.api.gax.rpc.UnaryCallSettings<UpdateFolderRequest,com.google.longrunning.Operation>	updateFolderSettings() Returns the object with the settings used for calls to updateFolder.

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

FoldersSettings

protected FoldersSettings(FoldersSettings.Builder settingsBuilder)
                   throws IOException

Throws:

IOException

Method Detail

getFolderSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetFolderRequest,Folder> getFolderSettings()

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

listFoldersSettings

public com.google.api.gax.rpc.PagedCallSettings<ListFoldersRequest,ListFoldersResponse,FoldersClient.ListFoldersPagedResponse> listFoldersSettings()

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

searchFoldersSettings

public com.google.api.gax.rpc.PagedCallSettings<SearchFoldersRequest,SearchFoldersResponse,FoldersClient.SearchFoldersPagedResponse> searchFoldersSettings()

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

createFolderSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateFolderRequest,com.google.longrunning.Operation> createFolderSettings()

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

createFolderOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateFolderRequest,Folder,CreateFolderMetadata> createFolderOperationSettings()

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

updateFolderSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateFolderRequest,com.google.longrunning.Operation> updateFolderSettings()

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

updateFolderOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateFolderRequest,Folder,UpdateFolderMetadata> updateFolderOperationSettings()

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

moveFolderSettings

public com.google.api.gax.rpc.UnaryCallSettings<MoveFolderRequest,com.google.longrunning.Operation> moveFolderSettings()

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

moveFolderOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<MoveFolderRequest,Folder,MoveFolderMetadata> moveFolderOperationSettings()

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

deleteFolderSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteFolderRequest,com.google.longrunning.Operation> deleteFolderSettings()

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

deleteFolderOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteFolderRequest,Folder,DeleteFolderMetadata> deleteFolderOperationSettings()

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

undeleteFolderSettings

public com.google.api.gax.rpc.UnaryCallSettings<UndeleteFolderRequest,com.google.longrunning.Operation> undeleteFolderSettings()

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

undeleteFolderOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UndeleteFolderRequest,Folder,UndeleteFolderMetadata> undeleteFolderOperationSettings()

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

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 FoldersSettings create(FoldersStubSettings 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 FoldersSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static FoldersSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public FoldersSettings.Builder toBuilder()

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

Specified by:

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