Class FoldersSettings (1.53.0)

public class FoldersSettings extends 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 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 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)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 foldersSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > FoldersSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(FoldersStubSettings stub)

public static final FoldersSettings create(FoldersStubSettings stub)

Parameter
Name	Description
`stub`	`FoldersStubSettings`

Returns
Type	Description
`FoldersSettings`

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

Returns a new gRPC builder for this class.

Returns
Type	Description
`FoldersSettings.Builder`

newBuilder(ClientContext clientContext)

public static FoldersSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`FoldersSettings.Builder`

newHttpJsonBuilder()

public static FoldersSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
`FoldersSettings.Builder`

Constructors

FoldersSettings(FoldersSettings.Builder settingsBuilder)

protected FoldersSettings(FoldersSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`FoldersSettings.Builder`

Methods

createFolderOperationSettings()

public OperationCallSettings<CreateFolderRequest,Folder,CreateFolderMetadata> createFolderOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateFolderRequest,Folder,CreateFolderMetadata>`

createFolderSettings()

public UnaryCallSettings<CreateFolderRequest,Operation> createFolderSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateFolderRequest,Operation>`

deleteFolderOperationSettings()

public OperationCallSettings<DeleteFolderRequest,Folder,DeleteFolderMetadata> deleteFolderOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteFolderRequest,Folder,DeleteFolderMetadata>`

deleteFolderSettings()

public UnaryCallSettings<DeleteFolderRequest,Operation> deleteFolderSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteFolderRequest,Operation>`

getFolderSettings()

public UnaryCallSettings<GetFolderRequest,Folder> getFolderSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetFolderRequest,Folder>`

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>`

listFoldersSettings()

public PagedCallSettings<ListFoldersRequest,ListFoldersResponse,FoldersClient.ListFoldersPagedResponse> listFoldersSettings()

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

Returns
Type	Description
`PagedCallSettings<ListFoldersRequest,ListFoldersResponse,ListFoldersPagedResponse>`

moveFolderOperationSettings()

public OperationCallSettings<MoveFolderRequest,Folder,MoveFolderMetadata> moveFolderOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<MoveFolderRequest,Folder,MoveFolderMetadata>`

moveFolderSettings()

public UnaryCallSettings<MoveFolderRequest,Operation> moveFolderSettings()

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

Returns
Type	Description
`UnaryCallSettings<MoveFolderRequest,Operation>`

searchFoldersSettings()

public PagedCallSettings<SearchFoldersRequest,SearchFoldersResponse,FoldersClient.SearchFoldersPagedResponse> searchFoldersSettings()

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

Returns
Type	Description
`PagedCallSettings<SearchFoldersRequest,SearchFoldersResponse,SearchFoldersPagedResponse>`

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 FoldersSettings.Builder toBuilder()

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

Returns
Type	Description
`FoldersSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

undeleteFolderOperationSettings()

public OperationCallSettings<UndeleteFolderRequest,Folder,UndeleteFolderMetadata> undeleteFolderOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UndeleteFolderRequest,Folder,UndeleteFolderMetadata>`

undeleteFolderSettings()

public UnaryCallSettings<UndeleteFolderRequest,Operation> undeleteFolderSettings()

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

Returns
Type	Description
`UnaryCallSettings<UndeleteFolderRequest,Operation>`

updateFolderOperationSettings()

public OperationCallSettings<UpdateFolderRequest,Folder,UpdateFolderMetadata> updateFolderOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateFolderRequest,Folder,UpdateFolderMetadata>`

updateFolderSettings()

public UnaryCallSettings<UpdateFolderRequest,Operation> updateFolderSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateFolderRequest,Operation>`