public final class CloudFunction extends com.google.protobuf.GeneratedMessageV3 implements CloudFunctionOrBuilder
Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations. Next tag: 36Protobuf type
google.cloud.functions.v1.CloudFunction| Modifier and Type | Class and Description |
|---|---|
static class |
CloudFunction.Builder
Describes a Cloud Function that contains user computation executed in
response to an event.
|
static class |
CloudFunction.IngressSettings
Available ingress settings.
|
static class |
CloudFunction.SourceCodeCase |
static class |
CloudFunction.TriggerCase |
static class |
CloudFunction.VpcConnectorEgressSettings
Available egress settings.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Method and Description |
|---|---|
boolean |
containsBuildEnvironmentVariables(String key)
Build environment variables that shall be available during build time.
|
boolean |
containsEnvironmentVariables(String key)
Environment variables that shall be available during function execution.
|
boolean |
containsLabels(String key)
Labels associated with this Cloud Function.
|
boolean |
equals(Object obj) |
int |
getAvailableMemoryMb()
The amount of memory in MB available for a function.
|
Map<String,String> |
getBuildEnvironmentVariables()
Deprecated.
|
int |
getBuildEnvironmentVariablesCount()
Build environment variables that shall be available during build time.
|
Map<String,String> |
getBuildEnvironmentVariablesMap()
Build environment variables that shall be available during build time.
|
String |
getBuildEnvironmentVariablesOrDefault(String key,
String defaultValue)
Build environment variables that shall be available during build time.
|
String |
getBuildEnvironmentVariablesOrThrow(String key)
Build environment variables that shall be available during build time.
|
String |
getBuildId()
Output only.
|
com.google.protobuf.ByteString |
getBuildIdBytes()
Output only.
|
String |
getBuildName()
Output only.
|
com.google.protobuf.ByteString |
getBuildNameBytes()
Output only.
|
String |
getBuildWorkerPool()
Name of the Cloud Build Custom Worker Pool that should be used to build the
function.
|
com.google.protobuf.ByteString |
getBuildWorkerPoolBytes()
Name of the Cloud Build Custom Worker Pool that should be used to build the
function.
|
static CloudFunction |
getDefaultInstance() |
CloudFunction |
getDefaultInstanceForType() |
String |
getDescription()
User-provided description of a function.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
User-provided description of a function.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDockerRepository()
User managed repository created in Artifact Registry optionally with a
customer managed encryption key.
|
com.google.protobuf.ByteString |
getDockerRepositoryBytes()
User managed repository created in Artifact Registry optionally with a
customer managed encryption key.
|
String |
getEntryPoint()
The name of the function (as defined in source code) that will be
executed.
|
com.google.protobuf.ByteString |
getEntryPointBytes()
The name of the function (as defined in source code) that will be
executed.
|
Map<String,String> |
getEnvironmentVariables()
Deprecated.
|
int |
getEnvironmentVariablesCount()
Environment variables that shall be available during function execution.
|
Map<String,String> |
getEnvironmentVariablesMap()
Environment variables that shall be available during function execution.
|
String |
getEnvironmentVariablesOrDefault(String key,
String defaultValue)
Environment variables that shall be available during function execution.
|
String |
getEnvironmentVariablesOrThrow(String key)
Environment variables that shall be available during function execution.
|
EventTrigger |
getEventTrigger()
A source that fires events in response to a condition in another service.
|
EventTriggerOrBuilder |
getEventTriggerOrBuilder()
A source that fires events in response to a condition in another service.
|
HttpsTrigger |
getHttpsTrigger()
An HTTPS endpoint type of source that can be triggered via URL.
|
HttpsTriggerOrBuilder |
getHttpsTriggerOrBuilder()
An HTTPS endpoint type of source that can be triggered via URL.
|
CloudFunction.IngressSettings |
getIngressSettings()
The ingress settings for the function, controlling what traffic can reach
it.
|
int |
getIngressSettingsValue()
The ingress settings for the function, controlling what traffic can reach
it.
|
String |
getKmsKeyName()
Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt function resources.
|
com.google.protobuf.ByteString |
getKmsKeyNameBytes()
Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt function resources.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
Labels associated with this Cloud Function.
|
Map<String,String> |
getLabelsMap()
Labels associated with this Cloud Function.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
Labels associated with this Cloud Function.
|
String |
getLabelsOrThrow(String key)
Labels associated with this Cloud Function.
|
int |
getMaxInstances()
The limit on the maximum number of function instances that may coexist at a
given time.
|
int |
getMinInstances()
A lower bound for the number function instances that may coexist at a
given time.
|
String |
getName()
A user-defined name of the function.
|
com.google.protobuf.ByteString |
getNameBytes()
A user-defined name of the function.
|
String |
getNetwork()
The VPC Network that this cloud function can connect to.
|
com.google.protobuf.ByteString |
getNetworkBytes()
The VPC Network that this cloud function can connect to.
|
com.google.protobuf.Parser<CloudFunction> |
getParserForType() |
String |
getRuntime()
The runtime in which to run the function.
|
com.google.protobuf.ByteString |
getRuntimeBytes()
The runtime in which to run the function.
|
SecretEnvVar |
getSecretEnvironmentVariables(int index)
Secret environment variables configuration.
|
int |
getSecretEnvironmentVariablesCount()
Secret environment variables configuration.
|
List<SecretEnvVar> |
getSecretEnvironmentVariablesList()
Secret environment variables configuration.
|
SecretEnvVarOrBuilder |
getSecretEnvironmentVariablesOrBuilder(int index)
Secret environment variables configuration.
|
List<? extends SecretEnvVarOrBuilder> |
getSecretEnvironmentVariablesOrBuilderList()
Secret environment variables configuration.
|
SecretVolume |
getSecretVolumes(int index)
Secret volumes configuration.
|
int |
getSecretVolumesCount()
Secret volumes configuration.
|
List<SecretVolume> |
getSecretVolumesList()
Secret volumes configuration.
|
SecretVolumeOrBuilder |
getSecretVolumesOrBuilder(int index)
Secret volumes configuration.
|
List<? extends SecretVolumeOrBuilder> |
getSecretVolumesOrBuilderList()
Secret volumes configuration.
|
int |
getSerializedSize() |
String |
getServiceAccountEmail()
The email of the function's service account.
|
com.google.protobuf.ByteString |
getServiceAccountEmailBytes()
The email of the function's service account.
|
String |
getSourceArchiveUrl()
The Google Cloud Storage URL, starting with `gs://`, pointing to the zip
archive which contains the function.
|
com.google.protobuf.ByteString |
getSourceArchiveUrlBytes()
The Google Cloud Storage URL, starting with `gs://`, pointing to the zip
archive which contains the function.
|
CloudFunction.SourceCodeCase |
getSourceCodeCase() |
SourceRepository |
getSourceRepository()
**Beta Feature**
The source repository where a function is hosted.
|
SourceRepositoryOrBuilder |
getSourceRepositoryOrBuilder()
**Beta Feature**
The source repository where a function is hosted.
|
String |
getSourceToken()
Input only.
|
com.google.protobuf.ByteString |
getSourceTokenBytes()
Input only.
|
String |
getSourceUploadUrl()
The Google Cloud Storage signed URL used for source uploading, generated
by calling [google.cloud.functions.v1.GenerateUploadUrl].
|
com.google.protobuf.ByteString |
getSourceUploadUrlBytes()
The Google Cloud Storage signed URL used for source uploading, generated
by calling [google.cloud.functions.v1.GenerateUploadUrl].
|
CloudFunctionStatus |
getStatus()
Output only.
|
int |
getStatusValue()
Output only.
|
com.google.protobuf.Duration |
getTimeout()
The function execution timeout.
|
com.google.protobuf.DurationOrBuilder |
getTimeoutOrBuilder()
The function execution timeout.
|
CloudFunction.TriggerCase |
getTriggerCase() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
long |
getVersionId()
Output only.
|
String |
getVpcConnector()
The VPC Network Connector that this cloud function can connect to.
|
com.google.protobuf.ByteString |
getVpcConnectorBytes()
The VPC Network Connector that this cloud function can connect to.
|
CloudFunction.VpcConnectorEgressSettings |
getVpcConnectorEgressSettings()
The egress settings for the connector, controlling what traffic is diverted
through it.
|
int |
getVpcConnectorEgressSettingsValue()
The egress settings for the connector, controlling what traffic is diverted
through it.
|
boolean |
hasEventTrigger()
A source that fires events in response to a condition in another service.
|
int |
hashCode() |
boolean |
hasHttpsTrigger()
An HTTPS endpoint type of source that can be triggered via URL.
|
boolean |
hasSourceArchiveUrl()
The Google Cloud Storage URL, starting with `gs://`, pointing to the zip
archive which contains the function.
|
boolean |
hasSourceRepository()
**Beta Feature**
The source repository where a function is hosted.
|
boolean |
hasSourceUploadUrl()
The Google Cloud Storage signed URL used for source uploading, generated
by calling [google.cloud.functions.v1.GenerateUploadUrl].
|
boolean |
hasTimeout()
The function execution timeout.
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static CloudFunction.Builder |
newBuilder() |
static CloudFunction.Builder |
newBuilder(CloudFunction prototype) |
CloudFunction.Builder |
newBuilderForType() |
protected CloudFunction.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static CloudFunction |
parseDelimitedFrom(InputStream input) |
static CloudFunction |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CloudFunction |
parseFrom(byte[] data) |
static CloudFunction |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CloudFunction |
parseFrom(ByteBuffer data) |
static CloudFunction |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CloudFunction |
parseFrom(com.google.protobuf.ByteString data) |
static CloudFunction |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CloudFunction |
parseFrom(com.google.protobuf.CodedInputStream input) |
static CloudFunction |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CloudFunction |
parseFrom(InputStream input) |
static CloudFunction |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<CloudFunction> |
parser() |
CloudFunction.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int SOURCE_ARCHIVE_URL_FIELD_NUMBER
public static final int SOURCE_REPOSITORY_FIELD_NUMBER
public static final int SOURCE_UPLOAD_URL_FIELD_NUMBER
public static final int HTTPS_TRIGGER_FIELD_NUMBER
public static final int EVENT_TRIGGER_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
public static final int ENTRY_POINT_FIELD_NUMBER
public static final int RUNTIME_FIELD_NUMBER
public static final int TIMEOUT_FIELD_NUMBER
public static final int AVAILABLE_MEMORY_MB_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int VERSION_ID_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int ENVIRONMENT_VARIABLES_FIELD_NUMBER
public static final int BUILD_ENVIRONMENT_VARIABLES_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
public static final int MAX_INSTANCES_FIELD_NUMBER
public static final int MIN_INSTANCES_FIELD_NUMBER
public static final int VPC_CONNECTOR_FIELD_NUMBER
public static final int VPC_CONNECTOR_EGRESS_SETTINGS_FIELD_NUMBER
public static final int INGRESS_SETTINGS_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER
public static final int BUILD_WORKER_POOL_FIELD_NUMBER
public static final int BUILD_ID_FIELD_NUMBER
public static final int BUILD_NAME_FIELD_NUMBER
public static final int SECRET_ENVIRONMENT_VARIABLES_FIELD_NUMBER
public static final int SECRET_VOLUMES_FIELD_NUMBER
public static final int SOURCE_TOKEN_FIELD_NUMBER
public static final int DOCKER_REPOSITORY_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public CloudFunction.SourceCodeCase getSourceCodeCase()
getSourceCodeCase in interface CloudFunctionOrBuilderpublic CloudFunction.TriggerCase getTriggerCase()
getTriggerCase in interface CloudFunctionOrBuilderpublic String getName()
A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`
string name = 1;getName in interface CloudFunctionOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`
string name = 1;getNameBytes in interface CloudFunctionOrBuilderpublic String getDescription()
User-provided description of a function.
string description = 2;getDescription in interface CloudFunctionOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
User-provided description of a function.
string description = 2;getDescriptionBytes in interface CloudFunctionOrBuilderpublic boolean hasSourceArchiveUrl()
The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function.
string source_archive_url = 3;hasSourceArchiveUrl in interface CloudFunctionOrBuilderpublic String getSourceArchiveUrl()
The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function.
string source_archive_url = 3;getSourceArchiveUrl in interface CloudFunctionOrBuilderpublic com.google.protobuf.ByteString getSourceArchiveUrlBytes()
The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function.
string source_archive_url = 3;getSourceArchiveUrlBytes in interface CloudFunctionOrBuilderpublic boolean hasSourceRepository()
**Beta Feature** The source repository where a function is hosted.
.google.cloud.functions.v1.SourceRepository source_repository = 4;hasSourceRepository in interface CloudFunctionOrBuilderpublic SourceRepository getSourceRepository()
**Beta Feature** The source repository where a function is hosted.
.google.cloud.functions.v1.SourceRepository source_repository = 4;getSourceRepository in interface CloudFunctionOrBuilderpublic SourceRepositoryOrBuilder getSourceRepositoryOrBuilder()
**Beta Feature** The source repository where a function is hosted.
.google.cloud.functions.v1.SourceRepository source_repository = 4;getSourceRepositoryOrBuilder in interface CloudFunctionOrBuilderpublic boolean hasSourceUploadUrl()
The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)
string source_upload_url = 16;hasSourceUploadUrl in interface CloudFunctionOrBuilderpublic String getSourceUploadUrl()
The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)
string source_upload_url = 16;getSourceUploadUrl in interface CloudFunctionOrBuilderpublic com.google.protobuf.ByteString getSourceUploadUrlBytes()
The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)
string source_upload_url = 16;getSourceUploadUrlBytes in interface CloudFunctionOrBuilderpublic boolean hasHttpsTrigger()
An HTTPS endpoint type of source that can be triggered via URL.
.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;hasHttpsTrigger in interface CloudFunctionOrBuilderpublic HttpsTrigger getHttpsTrigger()
An HTTPS endpoint type of source that can be triggered via URL.
.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;getHttpsTrigger in interface CloudFunctionOrBuilderpublic HttpsTriggerOrBuilder getHttpsTriggerOrBuilder()
An HTTPS endpoint type of source that can be triggered via URL.
.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;getHttpsTriggerOrBuilder in interface CloudFunctionOrBuilderpublic boolean hasEventTrigger()
A source that fires events in response to a condition in another service.
.google.cloud.functions.v1.EventTrigger event_trigger = 6;hasEventTrigger in interface CloudFunctionOrBuilderpublic EventTrigger getEventTrigger()
A source that fires events in response to a condition in another service.
.google.cloud.functions.v1.EventTrigger event_trigger = 6;getEventTrigger in interface CloudFunctionOrBuilderpublic EventTriggerOrBuilder getEventTriggerOrBuilder()
A source that fires events in response to a condition in another service.
.google.cloud.functions.v1.EventTrigger event_trigger = 6;getEventTriggerOrBuilder in interface CloudFunctionOrBuilderpublic int getStatusValue()
Output only. Status of the function deployment.
.google.cloud.functions.v1.CloudFunctionStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStatusValue in interface CloudFunctionOrBuilderpublic CloudFunctionStatus getStatus()
Output only. Status of the function deployment.
.google.cloud.functions.v1.CloudFunctionStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStatus in interface CloudFunctionOrBuilderpublic String getEntryPoint()
The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in `source_location`.
string entry_point = 8;getEntryPoint in interface CloudFunctionOrBuilderpublic com.google.protobuf.ByteString getEntryPointBytes()
The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in `source_location`.
string entry_point = 8;getEntryPointBytes in interface CloudFunctionOrBuilderpublic String getRuntime()
The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the [`gcloud` command reference](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).
string runtime = 19;getRuntime in interface CloudFunctionOrBuilderpublic com.google.protobuf.ByteString getRuntimeBytes()
The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the [`gcloud` command reference](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).
string runtime = 19;getRuntimeBytes in interface CloudFunctionOrBuilderpublic boolean hasTimeout()
The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.
.google.protobuf.Duration timeout = 9;hasTimeout in interface CloudFunctionOrBuilderpublic com.google.protobuf.Duration getTimeout()
The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.
.google.protobuf.Duration timeout = 9;getTimeout in interface CloudFunctionOrBuilderpublic com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.
.google.protobuf.Duration timeout = 9;getTimeoutOrBuilder in interface CloudFunctionOrBuilderpublic int getAvailableMemoryMb()
The amount of memory in MB available for a function. Defaults to 256MB.
int32 available_memory_mb = 10;getAvailableMemoryMb in interface CloudFunctionOrBuilderpublic String getServiceAccountEmail()
The email of the function's service account. If empty, defaults to
`{project_id}@appspot.gserviceaccount.com`.
string service_account_email = 11;getServiceAccountEmail in interface CloudFunctionOrBuilderpublic com.google.protobuf.ByteString getServiceAccountEmailBytes()
The email of the function's service account. If empty, defaults to
`{project_id}@appspot.gserviceaccount.com`.
string service_account_email = 11;getServiceAccountEmailBytes in interface CloudFunctionOrBuilderpublic boolean hasUpdateTime()
Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface CloudFunctionOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface CloudFunctionOrBuilderpublic com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface CloudFunctionOrBuilderpublic long getVersionId()
Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
int64 version_id = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];getVersionId in interface CloudFunctionOrBuilderpublic int getLabelsCount()
CloudFunctionOrBuilderLabels associated with this Cloud Function.
map<string, string> labels = 15;getLabelsCount in interface CloudFunctionOrBuilderpublic boolean containsLabels(String key)
Labels associated with this Cloud Function.
map<string, string> labels = 15;containsLabels in interface CloudFunctionOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface CloudFunctionOrBuilderpublic Map<String,String> getLabelsMap()
Labels associated with this Cloud Function.
map<string, string> labels = 15;getLabelsMap in interface CloudFunctionOrBuilderpublic String getLabelsOrDefault(String key, String defaultValue)
Labels associated with this Cloud Function.
map<string, string> labels = 15;getLabelsOrDefault in interface CloudFunctionOrBuilderpublic String getLabelsOrThrow(String key)
Labels associated with this Cloud Function.
map<string, string> labels = 15;getLabelsOrThrow in interface CloudFunctionOrBuilderpublic int getEnvironmentVariablesCount()
CloudFunctionOrBuilderEnvironment variables that shall be available during function execution.
map<string, string> environment_variables = 17;getEnvironmentVariablesCount in interface CloudFunctionOrBuilderpublic boolean containsEnvironmentVariables(String key)
Environment variables that shall be available during function execution.
map<string, string> environment_variables = 17;containsEnvironmentVariables in interface CloudFunctionOrBuilder@Deprecated public Map<String,String> getEnvironmentVariables()
getEnvironmentVariablesMap() instead.getEnvironmentVariables in interface CloudFunctionOrBuilderpublic Map<String,String> getEnvironmentVariablesMap()
Environment variables that shall be available during function execution.
map<string, string> environment_variables = 17;getEnvironmentVariablesMap in interface CloudFunctionOrBuilderpublic String getEnvironmentVariablesOrDefault(String key, String defaultValue)
Environment variables that shall be available during function execution.
map<string, string> environment_variables = 17;getEnvironmentVariablesOrDefault in interface CloudFunctionOrBuilderpublic String getEnvironmentVariablesOrThrow(String key)
Environment variables that shall be available during function execution.
map<string, string> environment_variables = 17;getEnvironmentVariablesOrThrow in interface CloudFunctionOrBuilderpublic int getBuildEnvironmentVariablesCount()
CloudFunctionOrBuilderBuild environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;getBuildEnvironmentVariablesCount in interface CloudFunctionOrBuilderpublic boolean containsBuildEnvironmentVariables(String key)
Build environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;containsBuildEnvironmentVariables in interface CloudFunctionOrBuilder@Deprecated public Map<String,String> getBuildEnvironmentVariables()
getBuildEnvironmentVariablesMap() instead.getBuildEnvironmentVariables in interface CloudFunctionOrBuilderpublic Map<String,String> getBuildEnvironmentVariablesMap()
Build environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;getBuildEnvironmentVariablesMap in interface CloudFunctionOrBuilderpublic String getBuildEnvironmentVariablesOrDefault(String key, String defaultValue)
Build environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;getBuildEnvironmentVariablesOrDefault in interface CloudFunctionOrBuilderpublic String getBuildEnvironmentVariablesOrThrow(String key)
Build environment variables that shall be available during build time.
map<string, string> build_environment_variables = 28;getBuildEnvironmentVariablesOrThrow in interface CloudFunctionOrBuilderpublic String getNetwork()
The VPC Network that this cloud function can connect to. It can be
either the fully-qualified URI, or the short name of the network resource.
If the short network name is used, the network must belong to the same
project. Otherwise, it must belong to a project within the same
organization. The format of this field is either
`projects/{project}/global/networks/{network}` or `{network}`, where
`{project}` is a project id where the network is defined, and `{network}`
is the short name of the network.
This field is mutually exclusive with `vpc_connector` and will be replaced
by it.
See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
more information on connecting Cloud projects.
string network = 18;getNetwork in interface CloudFunctionOrBuilderpublic com.google.protobuf.ByteString getNetworkBytes()
The VPC Network that this cloud function can connect to. It can be
either the fully-qualified URI, or the short name of the network resource.
If the short network name is used, the network must belong to the same
project. Otherwise, it must belong to a project within the same
organization. The format of this field is either
`projects/{project}/global/networks/{network}` or `{network}`, where
`{project}` is a project id where the network is defined, and `{network}`
is the short name of the network.
This field is mutually exclusive with `vpc_connector` and will be replaced
by it.
See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
more information on connecting Cloud projects.
string network = 18;getNetworkBytes in interface CloudFunctionOrBuilderpublic int getMaxInstances()
The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the [Max Instances](https://cloud.google.com/functions/docs/max-instances) Guide for more details.
int32 max_instances = 20;getMaxInstances in interface CloudFunctionOrBuilderpublic int getMinInstances()
A lower bound for the number function instances that may coexist at a given time.
int32 min_instances = 32;getMinInstances in interface CloudFunctionOrBuilderpublic String getVpcConnector()
The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is `projects/*/locations/*/connectors/*` This field is mutually exclusive with `network` field and will eventually replace it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects.
string vpc_connector = 22;getVpcConnector in interface CloudFunctionOrBuilderpublic com.google.protobuf.ByteString getVpcConnectorBytes()
The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is `projects/*/locations/*/connectors/*` This field is mutually exclusive with `network` field and will eventually replace it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects.
string vpc_connector = 22;getVpcConnectorBytes in interface CloudFunctionOrBuilderpublic int getVpcConnectorEgressSettingsValue()
The egress settings for the connector, controlling what traffic is diverted through it.
.google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings vpc_connector_egress_settings = 23;
getVpcConnectorEgressSettingsValue in interface CloudFunctionOrBuilderpublic CloudFunction.VpcConnectorEgressSettings getVpcConnectorEgressSettings()
The egress settings for the connector, controlling what traffic is diverted through it.
.google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings vpc_connector_egress_settings = 23;
getVpcConnectorEgressSettings in interface CloudFunctionOrBuilderpublic int getIngressSettingsValue()
The ingress settings for the function, controlling what traffic can reach it.
.google.cloud.functions.v1.CloudFunction.IngressSettings ingress_settings = 24;getIngressSettingsValue in interface CloudFunctionOrBuilderpublic CloudFunction.IngressSettings getIngressSettings()
The ingress settings for the function, controlling what traffic can reach it.
.google.cloud.functions.v1.CloudFunction.IngressSettings ingress_settings = 24;getIngressSettings in interface CloudFunctionOrBuilderpublic String getKmsKeyName()
Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt function resources.
It must match the pattern
`projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
If specified, you must also provide an artifact registry repository using
the `docker_repository` field that was created with the same KMS crypto
key.
The following service accounts need to be granted Cloud KMS crypto key
encrypter/decrypter roles on the key.
1. Google Cloud Functions service account
(service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) -
Required to protect the function's image.
2. Google Storage service account
(service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) -
Required to protect the function's source code.
If this service account does not exist, deploying a function without a
KMS key or retrieving the service agent name provisions it. For more
information, see
https://cloud.google.com/storage/docs/projects#service-agents and
https://cloud.google.com/storage/docs/getting-service-agent#gsutil.
Google Cloud Functions delegates access to service agents to protect
function resources in internal projects that are not accessible by the
end user.
string kms_key_name = 25 [(.google.api.resource_reference) = { ... }getKmsKeyName in interface CloudFunctionOrBuilderpublic com.google.protobuf.ByteString getKmsKeyNameBytes()
Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt function resources.
It must match the pattern
`projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
If specified, you must also provide an artifact registry repository using
the `docker_repository` field that was created with the same KMS crypto
key.
The following service accounts need to be granted Cloud KMS crypto key
encrypter/decrypter roles on the key.
1. Google Cloud Functions service account
(service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) -
Required to protect the function's image.
2. Google Storage service account
(service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) -
Required to protect the function's source code.
If this service account does not exist, deploying a function without a
KMS key or retrieving the service agent name provisions it. For more
information, see
https://cloud.google.com/storage/docs/projects#service-agents and
https://cloud.google.com/storage/docs/getting-service-agent#gsutil.
Google Cloud Functions delegates access to service agents to protect
function resources in internal projects that are not accessible by the
end user.
string kms_key_name = 25 [(.google.api.resource_reference) = { ... }getKmsKeyNameBytes in interface CloudFunctionOrBuilderpublic String getBuildWorkerPool()
Name of the Cloud Build Custom Worker Pool that should be used to build the
function. The format of this field is
`projects/{project}/locations/{region}/workerPools/{workerPool}` where
`{project}` and `{region}` are the project id and region respectively where
the worker pool is defined and `{workerPool}` is the short name of the
worker pool.
If the project id is not the same as the function, then the Cloud
Functions Service Agent
(`service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com`) must
be granted the role Cloud Build Custom Workers Builder
(`roles/cloudbuild.customworkers.builder`) in the project.
string build_worker_pool = 26;getBuildWorkerPool in interface CloudFunctionOrBuilderpublic com.google.protobuf.ByteString getBuildWorkerPoolBytes()
Name of the Cloud Build Custom Worker Pool that should be used to build the
function. The format of this field is
`projects/{project}/locations/{region}/workerPools/{workerPool}` where
`{project}` and `{region}` are the project id and region respectively where
the worker pool is defined and `{workerPool}` is the short name of the
worker pool.
If the project id is not the same as the function, then the Cloud
Functions Service Agent
(`service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com`) must
be granted the role Cloud Build Custom Workers Builder
(`roles/cloudbuild.customworkers.builder`) in the project.
string build_worker_pool = 26;getBuildWorkerPoolBytes in interface CloudFunctionOrBuilderpublic String getBuildId()
Output only. The Cloud Build ID of the latest successful deployment of the function.
string build_id = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];getBuildId in interface CloudFunctionOrBuilderpublic com.google.protobuf.ByteString getBuildIdBytes()
Output only. The Cloud Build ID of the latest successful deployment of the function.
string build_id = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];getBuildIdBytes in interface CloudFunctionOrBuilderpublic String getBuildName()
Output only. The Cloud Build Name of the function deployment. `projects/<project-number>/locations/<region>/builds/<build-id>`.
string build_name = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];getBuildName in interface CloudFunctionOrBuilderpublic com.google.protobuf.ByteString getBuildNameBytes()
Output only. The Cloud Build Name of the function deployment. `projects/<project-number>/locations/<region>/builds/<build-id>`.
string build_name = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];getBuildNameBytes in interface CloudFunctionOrBuilderpublic List<SecretEnvVar> getSecretEnvironmentVariablesList()
Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
getSecretEnvironmentVariablesList in interface CloudFunctionOrBuilderpublic List<? extends SecretEnvVarOrBuilder> getSecretEnvironmentVariablesOrBuilderList()
Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
getSecretEnvironmentVariablesOrBuilderList in interface CloudFunctionOrBuilderpublic int getSecretEnvironmentVariablesCount()
Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
getSecretEnvironmentVariablesCount in interface CloudFunctionOrBuilderpublic SecretEnvVar getSecretEnvironmentVariables(int index)
Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
getSecretEnvironmentVariables in interface CloudFunctionOrBuilderpublic SecretEnvVarOrBuilder getSecretEnvironmentVariablesOrBuilder(int index)
Secret environment variables configuration.
repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29;
getSecretEnvironmentVariablesOrBuilder in interface CloudFunctionOrBuilderpublic List<SecretVolume> getSecretVolumesList()
Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;getSecretVolumesList in interface CloudFunctionOrBuilderpublic List<? extends SecretVolumeOrBuilder> getSecretVolumesOrBuilderList()
Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;getSecretVolumesOrBuilderList in interface CloudFunctionOrBuilderpublic int getSecretVolumesCount()
Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;getSecretVolumesCount in interface CloudFunctionOrBuilderpublic SecretVolume getSecretVolumes(int index)
Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;getSecretVolumes in interface CloudFunctionOrBuilderpublic SecretVolumeOrBuilder getSecretVolumesOrBuilder(int index)
Secret volumes configuration.
repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;getSecretVolumesOrBuilder in interface CloudFunctionOrBuilderpublic String getSourceToken()
Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
string source_token = 31 [(.google.api.field_behavior) = INPUT_ONLY];getSourceToken in interface CloudFunctionOrBuilderpublic com.google.protobuf.ByteString getSourceTokenBytes()
Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
string source_token = 31 [(.google.api.field_behavior) = INPUT_ONLY];getSourceTokenBytes in interface CloudFunctionOrBuilderpublic String getDockerRepository()
User managed repository created in Artifact Registry optionally with a
customer managed encryption key. If specified, deployments will use
Artifact Registry. If unspecified and the deployment is eligible to use
Artifact Registry, GCF will create and use a repository named
'gcf-artifacts' for every deployed region. This is the repository to which
the function docker image will be pushed after it is built by Cloud Build.
It must match the pattern
`projects/{project}/locations/{location}/repositories/{repository}`.
Cross-project repositories are not supported.
Cross-location repositories are not supported.
Repository format must be 'DOCKER'.
string docker_repository = 34 [(.google.api.resource_reference) = { ... }getDockerRepository in interface CloudFunctionOrBuilderpublic com.google.protobuf.ByteString getDockerRepositoryBytes()
User managed repository created in Artifact Registry optionally with a
customer managed encryption key. If specified, deployments will use
Artifact Registry. If unspecified and the deployment is eligible to use
Artifact Registry, GCF will create and use a repository named
'gcf-artifacts' for every deployed region. This is the repository to which
the function docker image will be pushed after it is built by Cloud Build.
It must match the pattern
`projects/{project}/locations/{location}/repositories/{repository}`.
Cross-project repositories are not supported.
Cross-location repositories are not supported.
Repository format must be 'DOCKER'.
string docker_repository = 34 [(.google.api.resource_reference) = { ... }getDockerRepositoryBytes in interface CloudFunctionOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static CloudFunction parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudFunction parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudFunction parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudFunction parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudFunction parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudFunction parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CloudFunction parseFrom(InputStream input) throws IOException
IOExceptionpublic static CloudFunction parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static CloudFunction parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static CloudFunction parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static CloudFunction parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static CloudFunction parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic CloudFunction.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static CloudFunction.Builder newBuilder()
public static CloudFunction.Builder newBuilder(CloudFunction prototype)
public CloudFunction.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected CloudFunction.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static CloudFunction getDefaultInstance()
public static com.google.protobuf.Parser<CloudFunction> parser()
public com.google.protobuf.Parser<CloudFunction> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public CloudFunction getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.