publicfinalclassFunctionextendsGeneratedMessageV3implementsFunctionOrBuilder
Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.
Protobuf type google.cloud.functions.v2beta.Function
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BUILD_CONFIG_FIELD_NUMBER
publicstaticfinalintBUILD_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
publicstaticfinalintCREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
publicstaticfinalintDESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ENVIRONMENT_FIELD_NUMBER
publicstaticfinalintENVIRONMENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
EVENT_TRIGGER_FIELD_NUMBER
publicstaticfinalintEVENT_TRIGGER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KMS_KEY_NAME_FIELD_NUMBER
publicstaticfinalintKMS_KEY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
publicstaticfinalintLABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
publicstaticfinalintNAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SATISFIES_PZS_FIELD_NUMBER
publicstaticfinalintSATISFIES_PZS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SERVICE_CONFIG_FIELD_NUMBER
publicstaticfinalintSERVICE_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
publicstaticfinalintSTATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_MESSAGES_FIELD_NUMBER
publicstaticfinalintSTATE_MESSAGES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
publicstaticfinalintUPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
URL_FIELD_NUMBER
publicstaticfinalintURL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
publicstaticFunctiongetDefaultInstance()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticFunction.BuildernewBuilder()
newBuilder(Function prototype)
publicstaticFunction.BuildernewBuilder(Functionprototype)
| Parameter |
|---|
| Name | Description |
prototype | Function
|
publicstaticFunctionparseDelimitedFrom(InputStreaminput)
publicstaticFunctionparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticFunctionparseFrom(byte[]data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticFunctionparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticFunctionparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticFunctionparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticFunctionparseFrom(CodedInputStreaminput)
publicstaticFunctionparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticFunctionparseFrom(InputStreaminput)
publicstaticFunctionparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticFunctionparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticFunctionparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<Function>parser()
Methods
containsLabels(String key)
publicbooleancontainsLabels(Stringkey)
Labels associated with this Cloud Function.
map<string, string> labels = 8;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
OverridesgetBuildConfig()
publicBuildConfiggetBuildConfig()
Describes the Build step of the function that builds a container from the given source.
.google.cloud.functions.v2beta.BuildConfig build_config = 3;
getBuildConfigOrBuilder()
publicBuildConfigOrBuildergetBuildConfigOrBuilder()
Describes the Build step of the function that builds a container from the given source.
.google.cloud.functions.v2beta.BuildConfig build_config = 3;
getCreateTime()
publicTimestampgetCreateTime()
Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions.
.google.protobuf.Timestamp create_time = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime. |
getCreateTimeOrBuilder()
publicTimestampOrBuildergetCreateTimeOrBuilder()
Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions.
.google.protobuf.Timestamp create_time = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
publicFunctiongetDefaultInstanceForType()
getDescription()
publicStringgetDescription()
User-provided description of a function.
string description = 2;
| Returns |
|---|
| Type | Description |
String | The description. |
getDescriptionBytes()
publicByteStringgetDescriptionBytes()
User-provided description of a function.
string description = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description. |
getEnvironment()
publicEnvironmentgetEnvironment()
Describe whether the function is 1st Gen or 2nd Gen.
.google.cloud.functions.v2beta.Environment environment = 10;
getEnvironmentValue()
publicintgetEnvironmentValue()
Describe whether the function is 1st Gen or 2nd Gen.
.google.cloud.functions.v2beta.Environment environment = 10;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for environment. |
getEventTrigger()
publicEventTriggergetEventTrigger()
An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
.google.cloud.functions.v2beta.EventTrigger event_trigger = 5;
getEventTriggerOrBuilder()
publicEventTriggerOrBuildergetEventTriggerOrBuilder()
An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
.google.cloud.functions.v2beta.EventTrigger event_trigger = 5;
getKmsKeyName()
publicStringgetKmsKeyName()
[Preview] 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}.
string kms_key_name = 25 [(.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
String | The kmsKeyName. |
getKmsKeyNameBytes()
publicByteStringgetKmsKeyNameBytes()
[Preview] 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}.
string kms_key_name = 25 [(.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for kmsKeyName. |
getLabels() (deprecated)
publicMap<String,String>getLabels()
getLabelsCount()
publicintgetLabelsCount()
Labels associated with this Cloud Function.
map<string, string> labels = 8;
| Returns |
|---|
| Type | Description |
int | |
getLabelsMap()
publicMap<String,String>getLabelsMap()
Labels associated with this Cloud Function.
map<string, string> labels = 8;
getLabelsOrDefault(String key, String defaultValue)
publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)
Labels associated with this Cloud Function.
map<string, string> labels = 8;
getLabelsOrThrow(String key)
publicStringgetLabelsOrThrow(Stringkey)
Labels associated with this Cloud Function.
map<string, string> labels = 8;
| Parameter |
|---|
| Name | Description |
key | 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 |
|---|
| Type | Description |
String | The name. |
getNameBytes()
publicByteStringgetNameBytes()
A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*
string name = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name. |
getParserForType()
publicParser<Function>getParserForType()
getSatisfiesPzs()
publicbooleangetSatisfiesPzs()
Output only. Reserved for future use.
bool satisfies_pzs = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | The satisfiesPzs. |
getSerializedSize()
publicintgetSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
OverridesgetServiceConfig()
publicServiceConfiggetServiceConfig()
Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2beta.ServiceConfig service_config = 4;
getServiceConfigOrBuilder()
publicServiceConfigOrBuildergetServiceConfigOrBuilder()
Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2beta.ServiceConfig service_config = 4;
getState()
publicFunction.StategetState()
Output only. State of the function.
.google.cloud.functions.v2beta.Function.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateMessages(int index)
publicStateMessagegetStateMessages(intindex)
Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2beta.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
|
getStateMessagesCount()
publicintgetStateMessagesCount()
Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2beta.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | |
getStateMessagesList()
publicList<StateMessage>getStateMessagesList()
Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2beta.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateMessagesOrBuilder(int index)
publicStateMessageOrBuildergetStateMessagesOrBuilder(intindex)
Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2beta.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
|---|
| Name | Description |
index | int
|
getStateMessagesOrBuilderList()
publicList<?extendsStateMessageOrBuilder>getStateMessagesOrBuilderList()
Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2beta.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.functions.v2beta.StateMessageOrBuilder> | |
getStateValue()
Output only. State of the function.
.google.cloud.functions.v2beta.Function.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for state. |
getUpdateTime()
publicTimestampgetUpdateTime()
Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime. |
getUpdateTimeOrBuilder()
publicTimestampOrBuildergetUpdateTimeOrBuilder()
Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUrl()
Output only. The deployed url for the function.
string url = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The url. |
getUrlBytes()
publicByteStringgetUrlBytes()
Output only. The deployed url for the function.
string url = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for url. |
hasBuildConfig()
publicbooleanhasBuildConfig()
Describes the Build step of the function that builds a container from the given source.
.google.cloud.functions.v2beta.BuildConfig build_config = 3;
| Returns |
|---|
| Type | Description |
boolean | Whether the buildConfig field is set. |
hasCreateTime()
publicbooleanhasCreateTime()
Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions.
.google.protobuf.Timestamp create_time = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set. |
hasEventTrigger()
publicbooleanhasEventTrigger()
An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
.google.cloud.functions.v2beta.EventTrigger event_trigger = 5;
| Returns |
|---|
| Type | Description |
boolean | Whether the eventTrigger field is set. |
hasServiceConfig()
publicbooleanhasServiceConfig()
Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2beta.ServiceConfig service_config = 4;
| Returns |
|---|
| Type | Description |
boolean | Whether the serviceConfig field is set. |
hasUpdateTime()
publicbooleanhasUpdateTime()
Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set. |
hashCode()
| Returns |
|---|
| Type | Description |
int | |
OverridesinternalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
internalGetMapFieldReflection(int number)
protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)
| Parameter |
|---|
| Name | Description |
number | int
|
| Returns |
|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
Overridescom.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
publicfinalbooleanisInitialized()
newBuilderForType()
publicFunction.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedFunction.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
toBuilder()
publicFunction.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
