- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.4
- 2.4.3
- 2.3.6
public class CloudFunctionsServiceSettings extends ClientSettings<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.Builder cloudFunctionsServiceSettingsBuilder =
CloudFunctionsServiceSettings.newBuilder();
cloudFunctionsServiceSettingsBuilder
.getFunctionSettings()
.setRetrySettings(
cloudFunctionsServiceSettingsBuilder
.getFunctionSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
CloudFunctionsServiceSettings cloudFunctionsServiceSettings =
cloudFunctionsServiceSettingsBuilder.build();
Static Methods
create(CloudFunctionsServiceStubSettings stub)
public static final CloudFunctionsServiceSettings create(CloudFunctionsServiceStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub | CloudFunctionsServiceStubSettings |
| Returns | |
|---|---|
| Type | Description |
CloudFunctionsServiceSettings | |
| 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 CloudFunctionsServiceSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
CloudFunctionsServiceSettings.Builder | |
newBuilder(ClientContext clientContext)
public static CloudFunctionsServiceSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext | ClientContext |
| Returns | |
|---|---|
| Type | Description |
CloudFunctionsServiceSettings.Builder | |
newHttpJsonBuilder()
public static CloudFunctionsServiceSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
CloudFunctionsServiceSettings.Builder | |
Constructors
CloudFunctionsServiceSettings(CloudFunctionsServiceSettings.Builder settingsBuilder)
protected CloudFunctionsServiceSettings(CloudFunctionsServiceSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder | CloudFunctionsServiceSettings.Builder |
Methods
callFunctionSettings()
public UnaryCallSettings<CallFunctionRequest,CallFunctionResponse> callFunctionSettings()Returns the object with the settings used for calls to callFunction.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CallFunctionRequest,CallFunctionResponse> | |
createFunctionOperationSettings()
public OperationCallSettings<CreateFunctionRequest,CloudFunction,OperationMetadataV1> createFunctionOperationSettings()Returns the object with the settings used for calls to createFunction.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateFunctionRequest,CloudFunction,OperationMetadataV1> | |
createFunctionSettings()
public UnaryCallSettings<CreateFunctionRequest,Operation> createFunctionSettings()Returns the object with the settings used for calls to createFunction.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateFunctionRequest,Operation> | |
deleteFunctionOperationSettings()
public OperationCallSettings<DeleteFunctionRequest,Empty,OperationMetadataV1> deleteFunctionOperationSettings()Returns the object with the settings used for calls to deleteFunction.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteFunctionRequest,Empty,OperationMetadataV1> | |
deleteFunctionSettings()
public UnaryCallSettings<DeleteFunctionRequest,Operation> deleteFunctionSettings()Returns the object with the settings used for calls to deleteFunction.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteFunctionRequest,Operation> | |
generateDownloadUrlSettings()
public UnaryCallSettings<GenerateDownloadUrlRequest,GenerateDownloadUrlResponse> generateDownloadUrlSettings()Returns the object with the settings used for calls to generateDownloadUrl.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GenerateDownloadUrlRequest,GenerateDownloadUrlResponse> | |
generateUploadUrlSettings()
public UnaryCallSettings<GenerateUploadUrlRequest,GenerateUploadUrlResponse> generateUploadUrlSettings()Returns the object with the settings used for calls to generateUploadUrl.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GenerateUploadUrlRequest,GenerateUploadUrlResponse> | |
getFunctionSettings()
public UnaryCallSettings<GetFunctionRequest,CloudFunction> getFunctionSettings()Returns the object with the settings used for calls to getFunction.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetFunctionRequest,CloudFunction> | |
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> | |
listFunctionsSettings()
public PagedCallSettings<ListFunctionsRequest,ListFunctionsResponse,CloudFunctionsServiceClient.ListFunctionsPagedResponse> listFunctionsSettings()Returns the object with the settings used for calls to listFunctions.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListFunctionsRequest,ListFunctionsResponse,ListFunctionsPagedResponse> | |
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 CloudFunctionsServiceSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
CloudFunctionsServiceSettings.Builder | |
updateFunctionOperationSettings()
public OperationCallSettings<UpdateFunctionRequest,CloudFunction,OperationMetadataV1> updateFunctionOperationSettings()Returns the object with the settings used for calls to updateFunction.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateFunctionRequest,CloudFunction,OperationMetadataV1> | |
updateFunctionSettings()
public UnaryCallSettings<UpdateFunctionRequest,Operation> updateFunctionSettings()Returns the object with the settings used for calls to updateFunction.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateFunctionRequest,Operation> | |