com.google.cloud.functions.v1

Interface CloudFunctionOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

CloudFunction, CloudFunction.Builder

public interface CloudFunctionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsEnvironmentVariables(String key) Environment variables that shall be available during function execution.
boolean	containsLabels(String key) Labels associated with this Cloud Function.
int	getAvailableMemoryMb() The amount of memory in MB available for a function.
String	getBuildId() Output only.
com.google.protobuf.ByteString	getBuildIdBytes() Output only.
String	getDescription() User-provided description of a function.
com.google.protobuf.ByteString	getDescriptionBytes() User-provided description of a function.
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.
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.
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.
String	getRuntime() The runtime in which to run the function.
com.google.protobuf.ByteString	getRuntimeBytes() The runtime in which to run the function.
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	getSourceUploadUrl() The Google Cloud Storage signed URL used for source uploading, generated by [google.cloud.functions.v1.GenerateUploadUrl][]
com.google.protobuf.ByteString	getSourceUploadUrlBytes() The Google Cloud Storage signed URL used for source uploading, generated by [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.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.
boolean	hasHttpsTrigger() An HTTPS endpoint type of source that can be triggered via URL.
boolean	hasSourceRepository() **Beta Feature** The source repository where a function is hosted.
boolean	hasTimeout() The function execution timeout.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 A user-defined name of the function. Function names must be unique
 globally and match pattern `projects/*/locations/*/functions/*`
 

string name = 1;

Returns:

The name.

getNameBytes

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;

Returns:

The bytes for name.

getDescription

String getDescription()

 User-provided description of a function.
 

string description = 2;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 User-provided description of a function.
 

string description = 2;

Returns:

The bytes for description.

getSourceArchiveUrl

String getSourceArchiveUrl()

 The Google Cloud Storage URL, starting with gs://, pointing to the zip
 archive which contains the function.
 

string source_archive_url = 3;

Returns:

The sourceArchiveUrl.

getSourceArchiveUrlBytes

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;

Returns:

The bytes for sourceArchiveUrl.

hasSourceRepository

boolean hasSourceRepository()

 **Beta Feature**
 The source repository where a function is hosted.
 

.google.cloud.functions.v1.SourceRepository source_repository = 4;

Returns:

Whether the sourceRepository field is set.

getSourceRepository

SourceRepository getSourceRepository()

 **Beta Feature**
 The source repository where a function is hosted.
 

.google.cloud.functions.v1.SourceRepository source_repository = 4;

Returns:

The sourceRepository.

getSourceRepositoryOrBuilder

SourceRepositoryOrBuilder getSourceRepositoryOrBuilder()

 **Beta Feature**
 The source repository where a function is hosted.
 

.google.cloud.functions.v1.SourceRepository source_repository = 4;

getSourceUploadUrl

String getSourceUploadUrl()

 The Google Cloud Storage signed URL used for source uploading, generated
 by [google.cloud.functions.v1.GenerateUploadUrl][]
 

string source_upload_url = 16;

Returns:

The sourceUploadUrl.

getSourceUploadUrlBytes

com.google.protobuf.ByteString getSourceUploadUrlBytes()

 The Google Cloud Storage signed URL used for source uploading, generated
 by [google.cloud.functions.v1.GenerateUploadUrl][]
 

string source_upload_url = 16;

Returns:

The bytes for sourceUploadUrl.

hasHttpsTrigger

boolean hasHttpsTrigger()

 An HTTPS endpoint type of source that can be triggered via URL.
 

.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;

Returns:

Whether the httpsTrigger field is set.

getHttpsTrigger

HttpsTrigger getHttpsTrigger()

 An HTTPS endpoint type of source that can be triggered via URL.
 

.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;

Returns:

The httpsTrigger.

getHttpsTriggerOrBuilder

HttpsTriggerOrBuilder getHttpsTriggerOrBuilder()

 An HTTPS endpoint type of source that can be triggered via URL.
 

.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;

hasEventTrigger

boolean hasEventTrigger()

 A source that fires events in response to a condition in another service.
 

.google.cloud.functions.v1.EventTrigger event_trigger = 6;

Returns:

Whether the eventTrigger field is set.

getEventTrigger

EventTrigger getEventTrigger()

 A source that fires events in response to a condition in another service.
 

.google.cloud.functions.v1.EventTrigger event_trigger = 6;

Returns:

The eventTrigger.

getEventTriggerOrBuilder

EventTriggerOrBuilder getEventTriggerOrBuilder()

 A source that fires events in response to a condition in another service.
 

.google.cloud.functions.v1.EventTrigger event_trigger = 6;

getStatusValue

int getStatusValue()

 Output only. Status of the function deployment.
 

.google.cloud.functions.v1.CloudFunctionStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for status.

getStatus

CloudFunctionStatus getStatus()

 Output only. Status of the function deployment.
 

.google.cloud.functions.v1.CloudFunctionStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The status.

getEntryPoint

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;

Returns:

The entryPoint.

getEntryPointBytes

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;

Returns:

The bytes for entryPoint.

getRuntime

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](/sdk/gcloud/reference/functions/deploy#--runtime).
 

string runtime = 19;

Returns:

The runtime.

getRuntimeBytes

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](/sdk/gcloud/reference/functions/deploy#--runtime).
 

string runtime = 19;

Returns:

The bytes for runtime.

hasTimeout

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;

Returns:

Whether the timeout field is set.

getTimeout

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;

Returns:

The timeout.

getTimeoutOrBuilder

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;

getAvailableMemoryMb

int getAvailableMemoryMb()

 The amount of memory in MB available for a function.
 Defaults to 256MB.
 

int32 available_memory_mb = 10;

Returns:

The availableMemoryMb.

getServiceAccountEmail

String getServiceAccountEmail()

 The email of the function's service account. If empty, defaults to
 `{project_id}@appspot.gserviceaccount.com`.
 

string service_account_email = 11;

Returns:

The serviceAccountEmail.

getServiceAccountEmailBytes

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;

Returns:

The bytes for serviceAccountEmail.

hasUpdateTime

boolean hasUpdateTime()

 Output only. The last update timestamp of a Cloud Function.
 

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the updateTime field is set.

getUpdateTime

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];

Returns:

The updateTime.

getUpdateTimeOrBuilder

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];

getVersionId

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];

Returns:

The versionId.

getLabelsCount

int getLabelsCount()

 Labels associated with this Cloud Function.
 

map<string, string> labels = 15;

containsLabels

boolean containsLabels(String key)

 Labels associated with this Cloud Function.
 

map<string, string> labels = 15;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> getLabelsMap()

 Labels associated with this Cloud Function.
 

map<string, string> labels = 15;

getLabelsOrDefault

String getLabelsOrDefault(String key,
                          String defaultValue)

 Labels associated with this Cloud Function.
 

map<string, string> labels = 15;

getLabelsOrThrow

String getLabelsOrThrow(String key)

 Labels associated with this Cloud Function.
 

map<string, string> labels = 15;

getEnvironmentVariablesCount

int getEnvironmentVariablesCount()

 Environment variables that shall be available during function execution.
 

map<string, string> environment_variables = 17;

containsEnvironmentVariables

boolean containsEnvironmentVariables(String key)

 Environment variables that shall be available during function execution.
 

map<string, string> environment_variables = 17;

getEnvironmentVariables

@Deprecated
Map<String,String> getEnvironmentVariables()

Deprecated.

Use getEnvironmentVariablesMap() instead.

getEnvironmentVariablesMap

Map<String,String> getEnvironmentVariablesMap()

 Environment variables that shall be available during function execution.
 

map<string, string> environment_variables = 17;

getEnvironmentVariablesOrDefault

String getEnvironmentVariablesOrDefault(String key,
                                        String defaultValue)

 Environment variables that shall be available during function execution.
 

map<string, string> environment_variables = 17;

getEnvironmentVariablesOrThrow

String getEnvironmentVariablesOrThrow(String key)

 Environment variables that shall be available during function execution.
 

map<string, string> environment_variables = 17;

getNetwork

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;

Returns:

The network.

getNetworkBytes

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;

Returns:

The bytes for network.

getMaxInstances

int getMaxInstances()

 The limit on the maximum number of function instances that may coexist at a
 given time.
 

int32 max_instances = 20;

Returns:

The maxInstances.

getVpcConnector

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;

Returns:

The vpcConnector.

getVpcConnectorBytes

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;

Returns:

The bytes for vpcConnector.

getVpcConnectorEgressSettingsValue

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;

Returns:

The enum numeric value on the wire for vpcConnectorEgressSettings.

getVpcConnectorEgressSettings

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;

Returns:

The vpcConnectorEgressSettings.

getIngressSettingsValue

int getIngressSettingsValue()

 The ingress settings for the function, controlling what traffic can reach
 it.
 

.google.cloud.functions.v1.CloudFunction.IngressSettings ingress_settings = 24;

Returns:

The enum numeric value on the wire for ingressSettings.

getIngressSettings

CloudFunction.IngressSettings getIngressSettings()

 The ingress settings for the function, controlling what traffic can reach
 it.
 

.google.cloud.functions.v1.CloudFunction.IngressSettings ingress_settings = 24;

Returns:

The ingressSettings.

getBuildId

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];

Returns:

The buildId.

getBuildIdBytes

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];

Returns:

The bytes for buildId.

getSourceCodeCase

CloudFunction.SourceCodeCase getSourceCodeCase()

getTriggerCase

CloudFunction.TriggerCase getTriggerCase()