Class Function (2.13.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.80.0 (latest)
- 2.78.0
- 2.77.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.72.0
- 2.70.0
- 2.69.0
- 2.66.0
- 2.65.0
- 2.64.0
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.4
- 2.4.3
- 2.3.6
publicfinalclass FunctionextendsGeneratedMessageV3implementsFunctionOrBuilderDescribes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.
Protobuf type google.cloud.functions.v2.Function
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > FunctionImplements
FunctionOrBuilderInherited Members
Static Fields
BUILD_CONFIG_FIELD_NUMBER
publicstaticfinalintBUILD_CONFIG_FIELD_NUMBERDESCRIPTION_FIELD_NUMBER
publicstaticfinalintDESCRIPTION_FIELD_NUMBERENVIRONMENT_FIELD_NUMBER
publicstaticfinalintENVIRONMENT_FIELD_NUMBEREVENT_TRIGGER_FIELD_NUMBER
publicstaticfinalintEVENT_TRIGGER_FIELD_NUMBERLABELS_FIELD_NUMBER
publicstaticfinalintLABELS_FIELD_NUMBERNAME_FIELD_NUMBER
publicstaticfinalintNAME_FIELD_NUMBERSERVICE_CONFIG_FIELD_NUMBER
publicstaticfinalintSERVICE_CONFIG_FIELD_NUMBERSTATE_FIELD_NUMBER
publicstaticfinalintSTATE_FIELD_NUMBERSTATE_MESSAGES_FIELD_NUMBER
publicstaticfinalintSTATE_MESSAGES_FIELD_NUMBERUPDATE_TIME_FIELD_NUMBER
publicstaticfinalintUPDATE_TIME_FIELD_NUMBERStatic Methods
getDefaultInstance()
publicstaticFunctiongetDefaultInstance()getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()newBuilder()
publicstaticFunction.BuildernewBuilder()newBuilder(Function prototype)
publicstaticFunction.BuildernewBuilder(Functionprototype)parseDelimitedFrom(InputStream input)
publicstaticFunctionparseDelimitedFrom(InputStreaminput)parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticFunctionparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(byte[] data)
publicstaticFunctionparseFrom(byte[]data)data
byte[]parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticFunctionparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)data
byte[]parseFrom(ByteString data)
publicstaticFunctionparseFrom(ByteStringdata)parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticFunctionparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)parseFrom(CodedInputStream input)
publicstaticFunctionparseFrom(CodedInputStreaminput)parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticFunctionparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(InputStream input)
publicstaticFunctionparseFrom(InputStreaminput)parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
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;
equals(Object obj)
publicbooleanequals(Objectobj)getBuildConfig()
publicBuildConfiggetBuildConfig()Describes the Build step of the function that builds a container from the given source.
.google.cloud.functions.v2.BuildConfig build_config = 3;
BuildConfig
The buildConfig.
getBuildConfigOrBuilder()
publicBuildConfigOrBuildergetBuildConfigOrBuilder()Describes the Build step of the function that builds a container from the given source.
.google.cloud.functions.v2.BuildConfig build_config = 3;
getDefaultInstanceForType()
publicFunctiongetDefaultInstanceForType()getDescription()
publicStringgetDescription()User-provided description of a function.
string description = 2;
String
The description.
getDescriptionBytes()
publicByteStringgetDescriptionBytes()User-provided description of a function.
string description = 2;
ByteString
The bytes for description.
getEnvironment()
publicEnvironmentgetEnvironment()Describe whether the function is gen1 or gen2.
.google.cloud.functions.v2.Environment environment = 10;
Environment
The environment.
getEnvironmentValue()
publicintgetEnvironmentValue()Describe whether the function is gen1 or gen2.
.google.cloud.functions.v2.Environment environment = 10;
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.v2.EventTrigger event_trigger = 5;
EventTrigger
The eventTrigger.
getEventTriggerOrBuilder()
publicEventTriggerOrBuildergetEventTriggerOrBuilder()An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
.google.cloud.functions.v2.EventTrigger event_trigger = 5;
getLabels()
publicMap<String,String>getLabels()Use #getLabelsMap() instead.
getLabelsCount()
publicintgetLabelsCount()Labels associated with this Cloud Function.
map<string, string> labels = 8;
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;
getName()
publicStringgetName() A user-defined name of the function. Function names must be unique
globally and match pattern projects/*/locations/*/functions/*
string name = 1;
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;
ByteString
The bytes for name.
getParserForType()
publicParser<Function>getParserForType()getSerializedSize()
publicintgetSerializedSize()getServiceConfig()
publicServiceConfiggetServiceConfig()Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2.ServiceConfig service_config = 4;
ServiceConfig
The serviceConfig.
getServiceConfigOrBuilder()
publicServiceConfigOrBuildergetServiceConfigOrBuilder()Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2.ServiceConfig service_config = 4;
getState()
publicFunction.StategetState()Output only. State of the function.
.google.cloud.functions.v2.Function.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Function.State
The state.
getStateMessages(int index)
publicStateMessagegetStateMessages(intindex)Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateMessagesCount()
publicintgetStateMessagesCount()Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateMessagesList()
publicList<StateMessage>getStateMessagesList()Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.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.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateMessagesOrBuilderList()
publicList<?extendsStateMessageOrBuilder>getStateMessagesOrBuilderList()Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
List<? extends com.google.cloud.functions.v2.StateMessageOrBuilder>
getStateValue()
publicintgetStateValue()Output only. State of the function.
.google.cloud.functions.v2.Function.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
int
The enum numeric value on the wire for state.
getUnknownFields()
publicfinalUnknownFieldSetgetUnknownFields()getUpdateTime()
publicTimestampgetUpdateTime()Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
hasBuildConfig()
publicbooleanhasBuildConfig()Describes the Build step of the function that builds a container from the given source.
.google.cloud.functions.v2.BuildConfig build_config = 3;
boolean
Whether the buildConfig 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.v2.EventTrigger event_trigger = 5;
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.v2.ServiceConfig service_config = 4;
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];
boolean
Whether the updateTime field is set.
hashCode()
publicinthashCode()internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()internalGetMapField(int number)
protectedMapFieldinternalGetMapField(intnumber)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)