Class FoldersSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<FoldersSettings>
-
- com.google.cloud.resourcemanager.v3.FoldersSettings
-
@Generated("by gapic-generator-java") public class FoldersSettings extends com.google.api.gax.rpc.ClientSettings<FoldersSettings>
Settings class to configure an instance ofFoldersClient
.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();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FoldersSettings.Builder
Builder for FoldersSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
FoldersSettings(FoldersSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString
-
-
-
-
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
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") 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
@BetaApi 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 classcom.google.api.gax.rpc.ClientSettings<FoldersSettings>
-
-