Class CloudFunctionsServiceStubSettings (2.4.2)

public class CloudFunctionsServiceStubSettings extends StubSettings<CloudFunctionsServiceStubSettings>

Settings class to configure an instance of CloudFunctionsServiceStub.

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.
 CloudFunctionsServiceStubSettings.Builder cloudFunctionsServiceSettingsBuilder =
     CloudFunctionsServiceStubSettings.newBuilder();
 cloudFunctionsServiceSettingsBuilder
     .getFunctionSettings()
     .setRetrySettings(
         cloudFunctionsServiceSettingsBuilder
             .getFunctionSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CloudFunctionsServiceStubSettings cloudFunctionsServiceSettings =
     cloudFunctionsServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > CloudFunctionsServiceStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static CloudFunctionsServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
CloudFunctionsServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static CloudFunctionsServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
CloudFunctionsServiceStubSettings.Builder

newHttpJsonBuilder()

public static CloudFunctionsServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
CloudFunctionsServiceStubSettings.Builder

Constructors

CloudFunctionsServiceStubSettings(CloudFunctionsServiceStubSettings.Builder settingsBuilder)

protected CloudFunctionsServiceStubSettings(CloudFunctionsServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderCloudFunctionsServiceStubSettings.Builder

Methods

callFunctionSettings()

public UnaryCallSettings<CallFunctionRequest,CallFunctionResponse> callFunctionSettings()

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

Returns
TypeDescription
UnaryCallSettings<CallFunctionRequest,CallFunctionResponse>

createFunctionOperationSettings()

public OperationCallSettings<CreateFunctionRequest,CloudFunction,OperationMetadataV1> createFunctionOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateFunctionRequest,CloudFunction,OperationMetadataV1>

createFunctionSettings()

public UnaryCallSettings<CreateFunctionRequest,Operation> createFunctionSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateFunctionRequest,Operation>

createStub()

public CloudFunctionsServiceStub createStub()
Returns
TypeDescription
CloudFunctionsServiceStub
Exceptions
TypeDescription
IOException

deleteFunctionOperationSettings()

public OperationCallSettings<DeleteFunctionRequest,Empty,OperationMetadataV1> deleteFunctionOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteFunctionRequest,Empty,OperationMetadataV1>

deleteFunctionSettings()

public UnaryCallSettings<DeleteFunctionRequest,Operation> deleteFunctionSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteFunctionRequest,Operation>

generateDownloadUrlSettings()

public UnaryCallSettings<GenerateDownloadUrlRequest,GenerateDownloadUrlResponse> generateDownloadUrlSettings()

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

Returns
TypeDescription
UnaryCallSettings<GenerateDownloadUrlRequest,GenerateDownloadUrlResponse>

generateUploadUrlSettings()

public UnaryCallSettings<GenerateUploadUrlRequest,GenerateUploadUrlResponse> generateUploadUrlSettings()

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

Returns
TypeDescription
UnaryCallSettings<GenerateUploadUrlRequest,GenerateUploadUrlResponse>

getFunctionSettings()

public UnaryCallSettings<GetFunctionRequest,CloudFunction> getFunctionSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetFunctionRequest,CloudFunction>

getIamPolicySettings()

public UnaryCallSettings<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>

listFunctionsSettings()

public PagedCallSettings<ListFunctionsRequest,ListFunctionsResponse,CloudFunctionsServiceClient.ListFunctionsPagedResponse> listFunctionsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListFunctionsRequest,ListFunctionsResponse,ListFunctionsPagedResponse>

setIamPolicySettings()

public UnaryCallSettings<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()

public UnaryCallSettings<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()

public CloudFunctionsServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
CloudFunctionsServiceStubSettings.Builder
Overrides

updateFunctionOperationSettings()

public OperationCallSettings<UpdateFunctionRequest,CloudFunction,OperationMetadataV1> updateFunctionOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateFunctionRequest,CloudFunction,OperationMetadataV1>

updateFunctionSettings()

public UnaryCallSettings<UpdateFunctionRequest,Operation> updateFunctionSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateFunctionRequest,Operation>