com.google.cloud.functions.v1

Class CloudFunctionsServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<CloudFunctionsServiceSettings>

com.google.cloud.functions.v1.CloudFunctionsServiceSettings

@Generated(value="by gapic-generator-java")
public class CloudFunctionsServiceSettings
extends com.google.api.gax.rpc.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:

 CloudFunctionsServiceSettings.Builder cloudFunctionsServiceSettingsBuilder =
     CloudFunctionsServiceSettings.newBuilder();
 cloudFunctionsServiceSettingsBuilder
     .getFunctionSettings()
     .setRetrySettings(
         cloudFunctionsServiceSettingsBuilder
             .getFunctionSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CloudFunctionsServiceSettings cloudFunctionsServiceSettings =
     cloudFunctionsServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloudFunctionsServiceSettings.Builder Builder for CloudFunctionsServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CloudFunctionsServiceSettings(CloudFunctionsServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<CallFunctionRequest,CallFunctionResponse>	callFunctionSettings() Returns the object with the settings used for calls to callFunction.
static CloudFunctionsServiceSettings	create(CloudFunctionsServiceStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateFunctionRequest,CloudFunction,OperationMetadataV1>	createFunctionOperationSettings() Returns the object with the settings used for calls to createFunction.
com.google.api.gax.rpc.UnaryCallSettings<CreateFunctionRequest,com.google.longrunning.Operation>	createFunctionSettings() Returns the object with the settings used for calls to createFunction.
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 ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteFunctionRequest,com.google.protobuf.Empty,OperationMetadataV1>	deleteFunctionOperationSettings() Returns the object with the settings used for calls to deleteFunction.
com.google.api.gax.rpc.UnaryCallSettings<DeleteFunctionRequest,com.google.longrunning.Operation>	deleteFunctionSettings() Returns the object with the settings used for calls to deleteFunction.
com.google.api.gax.rpc.UnaryCallSettings<GenerateDownloadUrlRequest,GenerateDownloadUrlResponse>	generateDownloadUrlSettings() Returns the object with the settings used for calls to generateDownloadUrl.
com.google.api.gax.rpc.UnaryCallSettings<GenerateUploadUrlRequest,GenerateUploadUrlResponse>	generateUploadUrlSettings() Returns the object with the settings used for calls to generateUploadUrl.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetFunctionRequest,CloudFunction>	getFunctionSettings() Returns the object with the settings used for calls to getFunction.
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<ListFunctionsRequest,ListFunctionsResponse,CloudFunctionsServiceClient.ListFunctionsPagedResponse>	listFunctionsSettings() Returns the object with the settings used for calls to listFunctions.
static CloudFunctionsServiceSettings.Builder	newBuilder() Returns a new builder for this class.
static CloudFunctionsServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
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.
CloudFunctionsServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateFunctionRequest,CloudFunction,OperationMetadataV1>	updateFunctionOperationSettings() Returns the object with the settings used for calls to updateFunction.
com.google.api.gax.rpc.UnaryCallSettings<UpdateFunctionRequest,com.google.longrunning.Operation>	updateFunctionSettings() Returns the object with the settings used for calls to updateFunction.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CloudFunctionsServiceSettings

protected CloudFunctionsServiceSettings(CloudFunctionsServiceSettings.Builder settingsBuilder)
                                 throws IOException

Throws:

IOException

Method Detail

listFunctionsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListFunctionsRequest,ListFunctionsResponse,CloudFunctionsServiceClient.ListFunctionsPagedResponse> listFunctionsSettings()

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

getFunctionSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetFunctionRequest,CloudFunction> getFunctionSettings()

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

createFunctionSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateFunctionRequest,com.google.longrunning.Operation> createFunctionSettings()

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

createFunctionOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateFunctionRequest,CloudFunction,OperationMetadataV1> createFunctionOperationSettings()

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

updateFunctionSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateFunctionRequest,com.google.longrunning.Operation> updateFunctionSettings()

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

updateFunctionOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateFunctionRequest,CloudFunction,OperationMetadataV1> updateFunctionOperationSettings()

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

deleteFunctionSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteFunctionRequest,com.google.longrunning.Operation> deleteFunctionSettings()

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

deleteFunctionOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteFunctionRequest,com.google.protobuf.Empty,OperationMetadataV1> deleteFunctionOperationSettings()

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

callFunctionSettings

public com.google.api.gax.rpc.UnaryCallSettings<CallFunctionRequest,CallFunctionResponse> callFunctionSettings()

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

generateUploadUrlSettings

public com.google.api.gax.rpc.UnaryCallSettings<GenerateUploadUrlRequest,GenerateUploadUrlResponse> generateUploadUrlSettings()

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

generateDownloadUrlSettings

public com.google.api.gax.rpc.UnaryCallSettings<GenerateDownloadUrlRequest,GenerateDownloadUrlResponse> generateDownloadUrlSettings()

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

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.

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.

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 CloudFunctionsServiceSettings create(CloudFunctionsServiceStubSettings 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 ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="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 CloudFunctionsServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static CloudFunctionsServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public CloudFunctionsServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<CloudFunctionsServiceSettings>