Class Function.Builder (2.35.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
publicstaticfinalclass Function.BuilderextendsGeneratedMessageV3.Builder<Function.Builder>implementsFunctionOrBuilderDescribes 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Function.BuilderImplements
FunctionOrBuilderInherited Members
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllStateMessages(Iterable<? extends StateMessage> values)
publicFunction.BuilderaddAllStateMessages(Iterable<?extendsStateMessage>values)Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.functions.v2.StateMessage> |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicFunction.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
addStateMessages(StateMessage value)
publicFunction.BuilderaddStateMessages(StateMessagevalue)Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
StateMessage |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
addStateMessages(StateMessage.Builder builderForValue)
publicFunction.BuilderaddStateMessages(StateMessage.BuilderbuilderForValue)Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
StateMessage.Builder |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
addStateMessages(int index, StateMessage value)
publicFunction.BuilderaddStateMessages(intindex,StateMessagevalue)Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
StateMessage |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
addStateMessages(int index, StateMessage.Builder builderForValue)
publicFunction.BuilderaddStateMessages(intindex,StateMessage.BuilderbuilderForValue)Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
StateMessage.Builder |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
addStateMessagesBuilder()
publicStateMessage.BuilderaddStateMessagesBuilder()Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
StateMessage.Builder |
|
addStateMessagesBuilder(int index)
publicStateMessage.BuilderaddStateMessagesBuilder(intindex)Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
StateMessage.Builder |
|
build()
publicFunctionbuild()| Returns | |
|---|---|
| Type | Description |
Function |
|
buildPartial()
publicFunctionbuildPartial()| Returns | |
|---|---|
| Type | Description |
Function |
|
clear()
publicFunction.Builderclear()| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
clearBuildConfig()
publicFunction.BuilderclearBuildConfig()Describes the Build step of the function that builds a container from the given source.
.google.cloud.functions.v2.BuildConfig build_config = 3;
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
clearDescription()
publicFunction.BuilderclearDescription()User-provided description of a function.
string description = 2;
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |
clearEnvironment()
publicFunction.BuilderclearEnvironment()Describe whether the function is 1st Gen or 2nd Gen.
.google.cloud.functions.v2.Environment environment = 10;
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |
clearEventTrigger()
publicFunction.BuilderclearEventTrigger()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;
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
clearField(Descriptors.FieldDescriptor field)
publicFunction.BuilderclearField(Descriptors.FieldDescriptorfield)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
clearKmsKeyName()
publicFunction.BuilderclearKmsKeyName()[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 |
Function.Builder |
This builder for chaining. |
clearLabels()
publicFunction.BuilderclearLabels()| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
clearName()
publicFunction.BuilderclearName() 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 |
Function.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
publicFunction.BuilderclearOneof(Descriptors.OneofDescriptoroneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
clearServiceConfig()
publicFunction.BuilderclearServiceConfig()Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2.ServiceConfig service_config = 4;
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
clearState()
publicFunction.BuilderclearState()Output only. State of the function.
.google.cloud.functions.v2.Function.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |
clearStateMessages()
publicFunction.BuilderclearStateMessages()Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
clearUpdateTime()
publicFunction.BuilderclearUpdateTime()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 |
Function.Builder |
|
clearUrl()
publicFunction.BuilderclearUrl()Output only. The deployed url for the function.
string url = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |
clone()
publicFunction.Builderclone()| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
containsLabels(String key)
publicbooleancontainsLabels(Stringkey)Labels associated with this Cloud Function.
map<string, string> labels = 8;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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;
| Returns | |
|---|---|
| Type | Description |
BuildConfig |
The buildConfig. |
getBuildConfigBuilder()
publicBuildConfig.BuildergetBuildConfigBuilder()Describes the Build step of the function that builds a container from the given source.
.google.cloud.functions.v2.BuildConfig build_config = 3;
| Returns | |
|---|---|
| Type | Description |
BuildConfig.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
BuildConfigOrBuilder |
|
getDefaultInstanceForType()
publicFunctiongetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Function |
|
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. |
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEnvironment()
publicEnvironmentgetEnvironment()Describe whether the function is 1st Gen or 2nd Gen.
.google.cloud.functions.v2.Environment environment = 10;
| Returns | |
|---|---|
| Type | Description |
Environment |
The environment. |
getEnvironmentValue()
publicintgetEnvironmentValue()Describe whether the function is 1st Gen or 2nd Gen.
.google.cloud.functions.v2.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.v2.EventTrigger event_trigger = 5;
| Returns | |
|---|---|
| Type | Description |
EventTrigger |
The eventTrigger. |
getEventTriggerBuilder()
publicEventTrigger.BuildergetEventTriggerBuilder()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;
| Returns | |
|---|---|
| Type | Description |
EventTrigger.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
EventTriggerOrBuilder |
|
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()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
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;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)Labels associated with this Cloud Function.
map<string, string> labels = 8;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
publicStringgetLabelsOrThrow(Stringkey)Labels associated with this Cloud Function.
map<string, string> labels = 8;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getMutableLabels() (deprecated)
publicMap<String,String>getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
publicStringgetName() 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. |
getServiceConfig()
publicServiceConfiggetServiceConfig()Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2.ServiceConfig service_config = 4;
| Returns | |
|---|---|
| Type | Description |
ServiceConfig |
The serviceConfig. |
getServiceConfigBuilder()
publicServiceConfig.BuildergetServiceConfigBuilder()Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2.ServiceConfig service_config = 4;
| Returns | |
|---|---|
| Type | Description |
ServiceConfig.Builder |
|
getServiceConfigOrBuilder()
publicServiceConfigOrBuildergetServiceConfigOrBuilder()Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2.ServiceConfig service_config = 4;
| Returns | |
|---|---|
| Type | Description |
ServiceConfigOrBuilder |
|
getState()
publicFunction.StategetState()Output only. State of the function.
.google.cloud.functions.v2.Function.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
StateMessage |
|
getStateMessagesBuilder(int index)
publicStateMessage.BuildergetStateMessagesBuilder(intindex)Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
StateMessage.Builder |
|
getStateMessagesBuilderList()
publicList<StateMessage.Builder>getStateMessagesBuilderList()Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
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];
| Returns | |
|---|---|
| Type | Description |
int |
|
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];
| Returns | |
|---|---|
| Type | Description |
List<StateMessage> |
|
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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
StateMessageOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
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];
| 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. |
getUpdateTimeBuilder()
publicTimestamp.BuildergetUpdateTimeBuilder()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 |
Builder |
|
getUpdateTimeOrBuilder()
publicTimestampOrBuildergetUpdateTimeOrBuilder()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 |
TimestampOrBuilder |
|
getUrl()
publicStringgetUrl()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.v2.BuildConfig build_config = 3;
| Returns | |
|---|---|
| Type | Description |
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;
| 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.v2.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. |
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapField(int number)
protectedMapFieldinternalGetMapField(intnumber)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
MapField |
|
internalGetMutableMapField(int number)
protectedMapFieldinternalGetMutableMapField(intnumber)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
MapField |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeBuildConfig(BuildConfig value)
publicFunction.BuildermergeBuildConfig(BuildConfigvalue)Describes the Build step of the function that builds a container from the given source.
.google.cloud.functions.v2.BuildConfig build_config = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
BuildConfig |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
mergeEventTrigger(EventTrigger value)
publicFunction.BuildermergeEventTrigger(EventTriggervalue)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;
| Parameter | |
|---|---|
| Name | Description |
value |
EventTrigger |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
mergeFrom(Function other)
publicFunction.BuildermergeFrom(Functionother)| Parameter | |
|---|---|
| Name | Description |
other |
Function |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicFunction.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
publicFunction.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
mergeServiceConfig(ServiceConfig value)
publicFunction.BuildermergeServiceConfig(ServiceConfigvalue)Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2.ServiceConfig service_config = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
ServiceConfig |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalFunction.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
mergeUpdateTime(Timestamp value)
publicFunction.BuildermergeUpdateTime(Timestampvalue)Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
putAllLabels(Map<String,String> values)
publicFunction.BuilderputAllLabels(Map<String,String>values)Labels associated with this Cloud Function.
map<string, string> labels = 8;
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
putLabels(String key, String value)
publicFunction.BuilderputLabels(Stringkey,Stringvalue)Labels associated with this Cloud Function.
map<string, string> labels = 8;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
removeLabels(String key)
publicFunction.BuilderremoveLabels(Stringkey)Labels associated with this Cloud Function.
map<string, string> labels = 8;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
removeStateMessages(int index)
publicFunction.BuilderremoveStateMessages(intindex)Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
setBuildConfig(BuildConfig value)
publicFunction.BuildersetBuildConfig(BuildConfigvalue)Describes the Build step of the function that builds a container from the given source.
.google.cloud.functions.v2.BuildConfig build_config = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
BuildConfig |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
setBuildConfig(BuildConfig.Builder builderForValue)
publicFunction.BuildersetBuildConfig(BuildConfig.BuilderbuilderForValue)Describes the Build step of the function that builds a container from the given source.
.google.cloud.functions.v2.BuildConfig build_config = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
BuildConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
setDescription(String value)
publicFunction.BuildersetDescription(Stringvalue)User-provided description of a function.
string description = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
String The description to set. |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
publicFunction.BuildersetDescriptionBytes(ByteStringvalue)User-provided description of a function.
string description = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |
setEnvironment(Environment value)
publicFunction.BuildersetEnvironment(Environmentvalue)Describe whether the function is 1st Gen or 2nd Gen.
.google.cloud.functions.v2.Environment environment = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
Environment The environment to set. |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |
setEnvironmentValue(int value)
publicFunction.BuildersetEnvironmentValue(intvalue)Describe whether the function is 1st Gen or 2nd Gen.
.google.cloud.functions.v2.Environment environment = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
int The enum numeric value on the wire for environment to set. |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |
setEventTrigger(EventTrigger value)
publicFunction.BuildersetEventTrigger(EventTriggervalue)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;
| Parameter | |
|---|---|
| Name | Description |
value |
EventTrigger |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
setEventTrigger(EventTrigger.Builder builderForValue)
publicFunction.BuildersetEventTrigger(EventTrigger.BuilderbuilderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
EventTrigger.Builder |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
publicFunction.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
setKmsKeyName(String value)
publicFunction.BuildersetKmsKeyName(Stringvalue)[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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
String The kmsKeyName to set. |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |
setKmsKeyNameBytes(ByteString value)
publicFunction.BuildersetKmsKeyNameBytes(ByteStringvalue)[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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes for kmsKeyName to set. |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |
setName(String value)
publicFunction.BuildersetName(Stringvalue) A user-defined name of the function. Function names must be unique
globally and match pattern projects/*/locations/*/functions/*
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
String The name to set. |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
publicFunction.BuildersetNameBytes(ByteStringvalue) A user-defined name of the function. Function names must be unique
globally and match pattern projects/*/locations/*/functions/*
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
publicFunction.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
setServiceConfig(ServiceConfig value)
publicFunction.BuildersetServiceConfig(ServiceConfigvalue)Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2.ServiceConfig service_config = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
ServiceConfig |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
setServiceConfig(ServiceConfig.Builder builderForValue)
publicFunction.BuildersetServiceConfig(ServiceConfig.BuilderbuilderForValue)Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2.ServiceConfig service_config = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ServiceConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
setState(Function.State value)
publicFunction.BuildersetState(Function.Statevalue)Output only. State of the function.
.google.cloud.functions.v2.Function.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Function.State The state to set. |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |
setStateMessages(int index, StateMessage value)
publicFunction.BuildersetStateMessages(intindex,StateMessagevalue)Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
StateMessage |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
setStateMessages(int index, StateMessage.Builder builderForValue)
publicFunction.BuildersetStateMessages(intindex,StateMessage.BuilderbuilderForValue)Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
StateMessage.Builder |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
setStateValue(int value)
publicFunction.BuildersetStateValue(intvalue)Output only. State of the function.
.google.cloud.functions.v2.Function.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
int The enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalFunction.BuildersetUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
setUpdateTime(Timestamp value)
publicFunction.BuildersetUpdateTime(Timestampvalue)Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
publicFunction.BuildersetUpdateTime(Timestamp.BuilderbuilderForValue)Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
|
setUrl(String value)
publicFunction.BuildersetUrl(Stringvalue)Output only. The deployed url for the function.
string url = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
String The url to set. |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |
setUrlBytes(ByteString value)
publicFunction.BuildersetUrlBytes(ByteStringvalue)Output only. The deployed url for the function.
string url = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes for url to set. |
| Returns | |
|---|---|
| Type | Description |
Function.Builder |
This builder for chaining. |