Class FunctionServiceStubSettings (2.62.0)

publicclassFunctionServiceStubSettingsextendsStubSettings<FunctionServiceStubSettings>

Settings class to configure an instance of FunctionServiceStub.

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 RetrySettings of getFunction:

// 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_libraryFunctionServiceStubSettings.BuilderfunctionServiceSettingsBuilder=FunctionServiceStubSettings.newBuilder();functionServiceSettingsBuilder.getFunctionSettings().setRetrySettings(functionServiceSettingsBuilder.getFunctionSettings().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());FunctionServiceStubSettingsfunctionServiceSettings=functionServiceSettingsBuilder.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 createFunction:

// 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_libraryFunctionServiceStubSettings.BuilderfunctionServiceSettingsBuilder=FunctionServiceStubSettings.newBuilder();TimedRetryAlgorithmtimedRetryAlgorithm=OperationalTimedPollAlgorithm.create(RetrySettings.newBuilder().setInitialRetryDelayDuration(Duration.ofMillis(500)).setRetryDelayMultiplier(1.5).setMaxRetryDelayDuration(Duration.ofMillis(5000)).setTotalTimeoutDuration(Duration.ofHours(24)).build());functionServiceSettingsBuilder.createClusterOperationSettings().setPollingAlgorithm(timedRetryAlgorithm).build();

Inheritance

java.lang.Object > StubSettings > FunctionServiceStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

publicstaticGoogleCredentialsProvider.BuilderdefaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

publicstaticInstantiatingExecutorProvider.BuilderdefaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultGrpcApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

publicstaticInstantiatingGrpcChannelProvider.BuilderdefaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultHttpJsonApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

publicstaticInstantiatingHttpJsonChannelProvider.BuilderdefaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

publicstaticTransportChannelProviderdefaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

publicstaticStringgetDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

publicstaticStringgetDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

publicstaticList<String>getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

publicstaticFunctionServiceStubSettings.BuildernewBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
FunctionServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

publicstaticFunctionServiceStubSettings.BuildernewBuilder(ClientContextclientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
FunctionServiceStubSettings.Builder

newHttpJsonBuilder()

publicstaticFunctionServiceStubSettings.BuildernewHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
FunctionServiceStubSettings.Builder

Constructors

FunctionServiceStubSettings(FunctionServiceStubSettings.Builder settingsBuilder)

protectedFunctionServiceStubSettings(FunctionServiceStubSettings.BuildersettingsBuilder)
Parameter
NameDescription
settingsBuilderFunctionServiceStubSettings.Builder

Methods

createFunctionOperationSettings()

publicOperationCallSettings<CreateFunctionRequest,Function,OperationMetadata>createFunctionOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateFunctionRequest,Function,OperationMetadata>

createFunctionSettings()

publicUnaryCallSettings<CreateFunctionRequest,Operation>createFunctionSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateFunctionRequest,Operation>

createStub()

publicFunctionServiceStubcreateStub()
Returns
TypeDescription
FunctionServiceStub
Exceptions
TypeDescription
IOException

deleteFunctionOperationSettings()

publicOperationCallSettings<DeleteFunctionRequest,Empty,OperationMetadata>deleteFunctionOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteFunctionRequest,Empty,OperationMetadata>

deleteFunctionSettings()

publicUnaryCallSettings<DeleteFunctionRequest,Operation>deleteFunctionSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteFunctionRequest,Operation>

generateDownloadUrlSettings()

publicUnaryCallSettings<GenerateDownloadUrlRequest,GenerateDownloadUrlResponse>generateDownloadUrlSettings()

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

Returns
TypeDescription
UnaryCallSettings<GenerateDownloadUrlRequest,GenerateDownloadUrlResponse>

generateUploadUrlSettings()

publicUnaryCallSettings<GenerateUploadUrlRequest,GenerateUploadUrlResponse>generateUploadUrlSettings()

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

Returns
TypeDescription
UnaryCallSettings<GenerateUploadUrlRequest,GenerateUploadUrlResponse>

getFunctionSettings()

publicUnaryCallSettings<GetFunctionRequest,Function>getFunctionSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetFunctionRequest,Function>

getIamPolicySettings()

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

getServiceName()

publicStringgetServiceName()

Returns the default service name.

Returns
TypeDescription
String
Overrides

listFunctionsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListFunctionsRequest,ListFunctionsResponse,ListFunctionsPagedResponse>

listLocationsSettings()

publicPagedCallSettings<ListLocationsRequest,ListLocationsResponse,FunctionServiceClient.ListLocationsPagedResponse>listLocationsSettings()

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

Returns
TypeDescription
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listRuntimesSettings()

publicUnaryCallSettings<ListRuntimesRequest,ListRuntimesResponse>listRuntimesSettings()

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

Returns
TypeDescription
UnaryCallSettings<ListRuntimesRequest,ListRuntimesResponse>

setIamPolicySettings()

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

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

publicFunctionServiceStubSettings.BuildertoBuilder()

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

Returns
TypeDescription
FunctionServiceStubSettings.Builder
Overrides

updateFunctionOperationSettings()

publicOperationCallSettings<UpdateFunctionRequest,Function,OperationMetadata>updateFunctionOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateFunctionRequest,Function,OperationMetadata>

updateFunctionSettings()

publicUnaryCallSettings<UpdateFunctionRequest,Operation>updateFunctionSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateFunctionRequest,Operation>