Class CloudFunctionsServiceSettings (2.18.0)

publicclass CloudFunctionsServiceSettingsextendsClientSettings<CloudFunctionsServiceSettings>

Settings class to configure an instance of CloudFunctionsServiceClient.

The default instance has everything set to sensible defaults:

The default service address (cloudfunctions.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 getFunction 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
CloudFunctionsServiceSettings.BuildercloudFunctionsServiceSettingsBuilder=
CloudFunctionsServiceSettings.newBuilder();
cloudFunctionsServiceSettingsBuilder
.getFunctionSettings()
.setRetrySettings(
cloudFunctionsServiceSettingsBuilder
.getFunctionSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
CloudFunctionsServiceSettingscloudFunctionsServiceSettings=
cloudFunctionsServiceSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > CloudFunctionsServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.notify()

Object.wait()

Object.wait(long,int)

Static Methods

create(CloudFunctionsServiceStubSettings stub)

publicstaticfinalCloudFunctionsServiceSettingscreate(CloudFunctionsServiceStubSettingsstub)

Parameter
Name	Description
`stub`	`CloudFunctionsServiceStubSettings`

Returns
Type	Description
`CloudFunctionsServiceSettings`

Exceptions
Type	Description
`IOException`

defaultApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultApiClientHeaderProviderBuilder()

Returns
Type	Description
`Builder`

defaultCredentialsProviderBuilder()

publicstaticGoogleCredentialsProvider.BuilderdefaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
`Builder`

defaultExecutorProviderBuilder()

publicstaticInstantiatingExecutorProvider.BuilderdefaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
`Builder`

defaultGrpcTransportProviderBuilder()

publicstaticInstantiatingGrpcChannelProvider.BuilderdefaultGrpcTransportProviderBuilder()

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

Returns
Type	Description
`Builder`

defaultHttpJsonTransportProviderBuilder()

publicstaticInstantiatingHttpJsonChannelProvider.BuilderdefaultHttpJsonTransportProviderBuilder()

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

Returns
Type	Description
`Builder`

defaultTransportChannelProvider()

publicstaticTransportChannelProviderdefaultTransportChannelProvider()

Returns
Type	Description
`TransportChannelProvider`

getDefaultEndpoint()

publicstaticStringgetDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
`String`

getDefaultServiceScopes()

publicstaticList<String>getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
`List<String>`

newBuilder()

publicstaticCloudFunctionsServiceSettings.BuildernewBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
`CloudFunctionsServiceSettings.Builder`

newBuilder(ClientContext clientContext)

publicstaticCloudFunctionsServiceSettings.BuildernewBuilder(ClientContextclientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`CloudFunctionsServiceSettings.Builder`

newHttpJsonBuilder()

publicstaticCloudFunctionsServiceSettings.BuildernewHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
`CloudFunctionsServiceSettings.Builder`

Constructors

CloudFunctionsServiceSettings(CloudFunctionsServiceSettings.Builder settingsBuilder)

protectedCloudFunctionsServiceSettings(CloudFunctionsServiceSettings.BuildersettingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`CloudFunctionsServiceSettings.Builder`

Methods

callFunctionSettings()

publicUnaryCallSettings<CallFunctionRequest,CallFunctionResponse>callFunctionSettings()

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

Returns
Type	Description
`UnaryCallSettings<CallFunctionRequest,CallFunctionResponse>`

createFunctionOperationSettings()

publicOperationCallSettings<CreateFunctionRequest,CloudFunction,OperationMetadataV1>createFunctionOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateFunctionRequest,CloudFunction,OperationMetadataV1>`

createFunctionSettings()

publicUnaryCallSettings<CreateFunctionRequest,Operation>createFunctionSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateFunctionRequest,Operation>`

deleteFunctionOperationSettings()

publicOperationCallSettings<DeleteFunctionRequest,Empty,OperationMetadataV1>deleteFunctionOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteFunctionRequest,Empty,OperationMetadataV1>`

deleteFunctionSettings()

publicUnaryCallSettings<DeleteFunctionRequest,Operation>deleteFunctionSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteFunctionRequest,Operation>`

generateDownloadUrlSettings()

publicUnaryCallSettings<GenerateDownloadUrlRequest,GenerateDownloadUrlResponse>generateDownloadUrlSettings()

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

Returns
Type	Description
`UnaryCallSettings<GenerateDownloadUrlRequest,GenerateDownloadUrlResponse>`

generateUploadUrlSettings()

publicUnaryCallSettings<GenerateUploadUrlRequest,GenerateUploadUrlResponse>generateUploadUrlSettings()

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

Returns
Type	Description
`UnaryCallSettings<GenerateUploadUrlRequest,GenerateUploadUrlResponse>`

getFunctionSettings()

publicUnaryCallSettings<GetFunctionRequest,CloudFunction>getFunctionSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetFunctionRequest,CloudFunction>`

getIamPolicySettings()

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

listFunctionsSettings()

publicPagedCallSettings<ListFunctionsRequest,ListFunctionsResponse,CloudFunctionsServiceClient.ListFunctionsPagedResponse>listFunctionsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListFunctionsRequest,ListFunctionsResponse,ListFunctionsPagedResponse>`

setIamPolicySettings()

publicUnaryCallSettings<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()

publicUnaryCallSettings<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()

publicCloudFunctionsServiceSettings.BuildertoBuilder()

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

Returns
Type	Description
`CloudFunctionsServiceSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateFunctionOperationSettings()

publicOperationCallSettings<UpdateFunctionRequest,CloudFunction,OperationMetadataV1>updateFunctionOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateFunctionRequest,CloudFunction,OperationMetadataV1>`

updateFunctionSettings()

publicUnaryCallSettings<UpdateFunctionRequest,Operation>updateFunctionSettings()