Class FoldersSettings (1.14.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 total timeout of getFolder to 30 seconds:


 // 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()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 FoldersSettings foldersSettings = foldersSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > FoldersSettings

Static Methods

create(FoldersStubSettings stub)

public static final FoldersSettings create(FoldersStubSettings stub)
Parameter
NameDescription
stubFoldersStubSettings
Returns
TypeDescription
FoldersSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static FoldersSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
FoldersSettings.Builder

newBuilder(ClientContext clientContext)

public static FoldersSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
FoldersSettings.Builder

newHttpJsonBuilder()

public static FoldersSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
FoldersSettings.Builder

Constructors

FoldersSettings(FoldersSettings.Builder settingsBuilder)

protected FoldersSettings(FoldersSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderFoldersSettings.Builder

Methods

createFolderOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateFolderRequest,Folder,CreateFolderMetadata>

createFolderSettings()

public UnaryCallSettings<CreateFolderRequest,Operation> createFolderSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateFolderRequest,Operation>

deleteFolderOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteFolderRequest,Folder,DeleteFolderMetadata>

deleteFolderSettings()

public UnaryCallSettings<DeleteFolderRequest,Operation> deleteFolderSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteFolderRequest,Operation>

getFolderSettings()

public UnaryCallSettings<GetFolderRequest,Folder> getFolderSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetFolderRequest,Folder>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
PagedCallSettings<ListFoldersRequest,ListFoldersResponse,ListFoldersPagedResponse>

moveFolderOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<MoveFolderRequest,Folder,MoveFolderMetadata>

moveFolderSettings()

public UnaryCallSettings<MoveFolderRequest,Operation> moveFolderSettings()

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

Returns
TypeDescription
UnaryCallSettings<MoveFolderRequest,Operation>

searchFoldersSettings()

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

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

Returns
TypeDescription
PagedCallSettings<SearchFoldersRequest,SearchFoldersResponse,SearchFoldersPagedResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
FoldersSettings.Builder
Overrides

undeleteFolderOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UndeleteFolderRequest,Folder,UndeleteFolderMetadata>

undeleteFolderSettings()

public UnaryCallSettings<UndeleteFolderRequest,Operation> undeleteFolderSettings()

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

Returns
TypeDescription
UnaryCallSettings<UndeleteFolderRequest,Operation>

updateFolderOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateFolderRequest,Folder,UpdateFolderMetadata>

updateFolderSettings()

public UnaryCallSettings<UpdateFolderRequest,Operation> updateFolderSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateFolderRequest,Operation>