Class FunctionServiceSettings (2.4.2)

public class FunctionServiceSettings extends ClientSettings<FunctionServiceSettings>

Settings class to configure an instance of FunctionServiceClient.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 FunctionServiceSettings.Builder functionServiceSettingsBuilder =
     FunctionServiceSettings.newBuilder();
 functionServiceSettingsBuilder
     .getFunctionSettings()
     .setRetrySettings(
         functionServiceSettingsBuilder
             .getFunctionSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 FunctionServiceSettings functionServiceSettings = functionServiceSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > FunctionServiceSettings

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.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(FunctionServiceStubSettings stub)

public static final FunctionServiceSettings create(FunctionServiceStubSettings stub)

Parameter

Name	Description
stub	`FunctionServiceStubSettings`

Returns

Type	Description
FunctionServiceSettings

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 FunctionServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns

Type	Description
FunctionServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static FunctionServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
FunctionServiceSettings.Builder

newHttpJsonBuilder()

public static FunctionServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Type	Description
FunctionServiceSettings.Builder

Constructors

FunctionServiceSettings(FunctionServiceSettings.Builder settingsBuilder)

protected FunctionServiceSettings(FunctionServiceSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`FunctionServiceSettings.Builder`

Methods

createFunctionOperationSettings()

public OperationCallSettings<CreateFunctionRequest,Function,OperationMetadata> createFunctionOperationSettings()

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

Returns

Type	Description
OperationCallSettings<CreateFunctionRequest,Function,OperationMetadata>

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,OperationMetadata> deleteFunctionOperationSettings()

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

Returns

Type	Description
OperationCallSettings<DeleteFunctionRequest,Empty,OperationMetadata>

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,Function> getFunctionSettings()

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

Returns

Type	Description
UnaryCallSettings<GetFunctionRequest,Function>

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,FunctionServiceClient.ListFunctionsPagedResponse> listFunctionsSettings()

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

Returns

Type	Description
PagedCallSettings<ListFunctionsRequest,ListFunctionsResponse,ListFunctionsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,FunctionServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns

Type	Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listRuntimesSettings()

public UnaryCallSettings<ListRuntimesRequest,ListRuntimesResponse> listRuntimesSettings()

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

Returns

Type	Description
UnaryCallSettings<ListRuntimesRequest,ListRuntimesResponse>

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 FunctionServiceSettings.Builder toBuilder()

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

Returns

Type	Description
FunctionServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateFunctionOperationSettings()

public OperationCallSettings<UpdateFunctionRequest,Function,OperationMetadata> updateFunctionOperationSettings()

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

Returns

Type	Description
OperationCallSettings<UpdateFunctionRequest,Function,OperationMetadata>

updateFunctionSettings()

public UnaryCallSettings<UpdateFunctionRequest,Operation> updateFunctionSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateFunctionRequest,Operation>