Class Function.Builder (2.56.0) 

public static final class Function.Builder extends GeneratedMessageV3.Builder<Function.Builder> implements FunctionOrBuilder

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Function.Builder

Implements

FunctionOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllStateMessages(Iterable<? extends StateMessage> values)

public Function.Builder addAllStateMessages(Iterable<? extends StateMessage> values)

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
values Iterable<? extends com.google.cloud.functions.v2beta.StateMessage>
Returns
Type Description
Function.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Function.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Function.Builder
Overrides

addStateMessages(StateMessage value)

public Function.Builder addStateMessages(StateMessage value)

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
value StateMessage
Returns
Type Description
Function.Builder

addStateMessages(StateMessage.Builder builderForValue)

public Function.Builder addStateMessages(StateMessage.Builder builderForValue)

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
builderForValue StateMessage.Builder
Returns
Type Description
Function.Builder

addStateMessages(int index, StateMessage value)

public Function.Builder addStateMessages(int index, StateMessage value)

Output only. State Messages for this Cloud Function.

repeated .google.cloud.functions.v2beta.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)

public Function.Builder addStateMessages(int index, StateMessage.Builder builderForValue)

Output only. State Messages for this Cloud Function.

repeated .google.cloud.functions.v2beta.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue StateMessage.Builder
Returns
Type Description
Function.Builder

addStateMessagesBuilder()

public StateMessage.Builder addStateMessagesBuilder()

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
StateMessage.Builder

addStateMessagesBuilder(int index)

public StateMessage.Builder addStateMessagesBuilder(int index)

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
Returns
Type Description
StateMessage.Builder

build()

public Function build()
Returns
Type Description
Function

buildPartial()

public Function buildPartial()
Returns
Type Description
Function

clear()

public Function.Builder clear()
Returns
Type Description
Function.Builder
Overrides

clearBuildConfig()

public Function.Builder clearBuildConfig()

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
Function.Builder

clearCreateTime()

public Function.Builder clearCreateTime()

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
Function.Builder

clearDescription()

public Function.Builder clearDescription()

User-provided description of a function.

string description = 2;

Returns
Type Description
Function.Builder

This builder for chaining.

clearEnvironment()

public Function.Builder clearEnvironment()

Describe whether the function is 1st Gen or 2nd Gen.

.google.cloud.functions.v2beta.Environment environment = 10;

Returns
Type Description
Function.Builder

This builder for chaining.

clearEventTrigger()

public Function.Builder clearEventTrigger()

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
Function.Builder

clearField(Descriptors.FieldDescriptor field)

public Function.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Function.Builder
Overrides

clearKmsKeyName()

public Function.Builder clearKmsKeyName()

[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()

public Function.Builder clearLabels()
Returns
Type Description
Function.Builder

clearName()

public Function.Builder clearName()

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)

public Function.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Function.Builder
Overrides

clearSatisfiesPzs()

public Function.Builder clearSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Function.Builder

This builder for chaining.

clearServiceConfig()

public Function.Builder clearServiceConfig()

Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).

.google.cloud.functions.v2beta.ServiceConfig service_config = 4;

Returns
Type Description
Function.Builder

clearState()

public Function.Builder clearState()

Output only. State of the function.

.google.cloud.functions.v2beta.Function.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Function.Builder

This builder for chaining.

clearStateMessages()

public Function.Builder clearStateMessages()

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
Function.Builder

clearUpdateTime()

public Function.Builder clearUpdateTime()

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()

public Function.Builder clearUrl()

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()

public Function.Builder clone()
Returns
Type Description
Function.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Labels associated with this Cloud Function.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description
boolean

getBuildConfig()

public BuildConfig getBuildConfig()

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
BuildConfig

The buildConfig.

getBuildConfigBuilder()

public BuildConfig.Builder getBuildConfigBuilder()

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
BuildConfig.Builder

getBuildConfigOrBuilder()

public BuildConfigOrBuilder getBuildConfigOrBuilder()

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
BuildConfigOrBuilder

getCreateTime()

public Timestamp getCreateTime()

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

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
TimestampOrBuilder

getDefaultInstanceForType()

public Function getDefaultInstanceForType()
Returns
Type Description
Function

getDescription()

public String getDescription()

User-provided description of a function.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

User-provided description of a function.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnvironment()

public Environment getEnvironment()

Describe whether the function is 1st Gen or 2nd Gen.

.google.cloud.functions.v2beta.Environment environment = 10;

Returns
Type Description
Environment

The environment.

getEnvironmentValue()

public int getEnvironmentValue()

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()

public EventTrigger getEventTrigger()

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
EventTrigger

The eventTrigger.

getEventTriggerBuilder()

public EventTrigger.Builder getEventTriggerBuilder()

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
EventTrigger.Builder

getEventTriggerOrBuilder()

public EventTriggerOrBuilder getEventTriggerOrBuilder()

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
EventTriggerOrBuilder

getKmsKeyName()

public String getKmsKeyName()

[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()

public ByteString getKmsKeyNameBytes()

[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)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels associated with this Cloud Function.

map<string, string> labels = 8;

Returns
Type Description
int

getLabelsMap()

public Map<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)

public String getLabelsOrDefault(String key, String defaultValue)

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)

public String getLabelsOrThrow(String key)

Labels associated with this Cloud Function.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public 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()

public 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
Type Description
ByteString

The bytes for name.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getServiceConfig()

public ServiceConfig getServiceConfig()

Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).

.google.cloud.functions.v2beta.ServiceConfig service_config = 4;

Returns
Type Description
ServiceConfig

The serviceConfig.

getServiceConfigBuilder()

public ServiceConfig.Builder getServiceConfigBuilder()

Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).

.google.cloud.functions.v2beta.ServiceConfig service_config = 4;

Returns
Type Description
ServiceConfig.Builder

getServiceConfigOrBuilder()

public ServiceConfigOrBuilder getServiceConfigOrBuilder()

Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).

.google.cloud.functions.v2beta.ServiceConfig service_config = 4;

Returns
Type Description
ServiceConfigOrBuilder

getState()

public Function.State getState()

Output only. State of the function.

.google.cloud.functions.v2beta.Function.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Function.State

The state.

getStateMessages(int index)

public StateMessage getStateMessages(int index)

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
Returns
Type Description
StateMessage

getStateMessagesBuilder(int index)

public StateMessage.Builder getStateMessagesBuilder(int index)

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
Returns
Type Description
StateMessage.Builder

getStateMessagesBuilderList()

public List<StateMessage.Builder> getStateMessagesBuilderList()

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<Builder>

getStateMessagesCount()

public int getStateMessagesCount()

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()

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

Returns
Type Description
List<StateMessage>

getStateMessagesOrBuilder(int index)

public StateMessageOrBuilder getStateMessagesOrBuilder(int index)

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
Returns
Type Description
StateMessageOrBuilder

getStateMessagesOrBuilderList()

public List<? extends StateMessageOrBuilder> 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()

public int 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()

public Timestamp getUpdateTime()

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()

public Timestamp.Builder getUpdateTimeBuilder()

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()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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()

public String 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()

public ByteString getUrlBytes()

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()

public boolean hasBuildConfig()

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()

public boolean hasCreateTime()

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()

public boolean hasEventTrigger()

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()

public boolean hasServiceConfig()

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()

public boolean hasUpdateTime()

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()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBuildConfig(BuildConfig value)

public Function.Builder mergeBuildConfig(BuildConfig value)

Describes the Build step of the function that builds a container from the given source.

.google.cloud.functions.v2beta.BuildConfig build_config = 3;

Parameter
Name Description
value BuildConfig
Returns
Type Description
Function.Builder

mergeCreateTime(Timestamp value)

public Function.Builder mergeCreateTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Function.Builder

mergeEventTrigger(EventTrigger value)

public Function.Builder mergeEventTrigger(EventTrigger value)

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;

Parameter
Name Description
value EventTrigger
Returns
Type Description
Function.Builder

mergeFrom(Function other)

public Function.Builder mergeFrom(Function other)
Parameter
Name Description
other Function
Returns
Type Description
Function.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Function.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Function.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Function.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Function.Builder
Overrides

mergeServiceConfig(ServiceConfig value)

public Function.Builder mergeServiceConfig(ServiceConfig value)

Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).

.google.cloud.functions.v2beta.ServiceConfig service_config = 4;

Parameter
Name Description
value ServiceConfig
Returns
Type Description
Function.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Function.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Function.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Function.Builder mergeUpdateTime(Timestamp value)

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)

public Function.Builder putAllLabels(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)

public Function.Builder putLabels(String key, String value)

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)

public Function.Builder removeLabels(String key)

Labels associated with this Cloud Function.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description
Function.Builder

removeStateMessages(int index)

public Function.Builder removeStateMessages(int index)

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
Returns
Type Description
Function.Builder

setBuildConfig(BuildConfig value)

public Function.Builder setBuildConfig(BuildConfig value)

Describes the Build step of the function that builds a container from the given source.

.google.cloud.functions.v2beta.BuildConfig build_config = 3;

Parameter
Name Description
value BuildConfig
Returns
Type Description
Function.Builder

setBuildConfig(BuildConfig.Builder builderForValue)

public Function.Builder setBuildConfig(BuildConfig.Builder builderForValue)

Describes the Build step of the function that builds a container from the given source.

.google.cloud.functions.v2beta.BuildConfig build_config = 3;

Parameter
Name Description
builderForValue BuildConfig.Builder
Returns
Type Description
Function.Builder

setCreateTime(Timestamp value)

public Function.Builder setCreateTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Function.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Function.Builder setCreateTime(Timestamp.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Function.Builder

setDescription(String value)

public Function.Builder setDescription(String value)

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)

public Function.Builder setDescriptionBytes(ByteString value)

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)

public Function.Builder setEnvironment(Environment value)

Describe whether the function is 1st Gen or 2nd Gen.

.google.cloud.functions.v2beta.Environment environment = 10;

Parameter
Name Description
value Environment

The environment to set.
Returns
Type Description
Function.Builder

This builder for chaining.

setEnvironmentValue(int value)

public Function.Builder setEnvironmentValue(int value)

Describe whether the function is 1st Gen or 2nd Gen.

.google.cloud.functions.v2beta.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)

public Function.Builder setEventTrigger(EventTrigger value)

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;

Parameter
Name Description
value EventTrigger
Returns
Type Description
Function.Builder

setEventTrigger(EventTrigger.Builder builderForValue)

public Function.Builder setEventTrigger(EventTrigger.Builder builderForValue)

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;

Parameter
Name Description
builderForValue EventTrigger.Builder
Returns
Type Description
Function.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Function.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Function.Builder
Overrides

setKmsKeyName(String value)

public Function.Builder setKmsKeyName(String value)

[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)

public Function.Builder setKmsKeyNameBytes(ByteString value)

[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)

public Function.Builder setName(String value)

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)

public Function.Builder setNameBytes(ByteString value)

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)

public Function.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Function.Builder
Overrides

setSatisfiesPzs(boolean value)

public Function.Builder setSatisfiesPzs(boolean value)

Output only. Reserved for future use.

bool satisfies_pzs = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzs to set.
Returns
Type Description
Function.Builder

This builder for chaining.

setServiceConfig(ServiceConfig value)

public Function.Builder setServiceConfig(ServiceConfig value)

Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).

.google.cloud.functions.v2beta.ServiceConfig service_config = 4;

Parameter
Name Description
value ServiceConfig
Returns
Type Description
Function.Builder

setServiceConfig(ServiceConfig.Builder builderForValue)

public Function.Builder setServiceConfig(ServiceConfig.Builder builderForValue)

Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).

.google.cloud.functions.v2beta.ServiceConfig service_config = 4;

Parameter
Name Description
builderForValue ServiceConfig.Builder
Returns
Type Description
Function.Builder

setState(Function.State value)

public Function.Builder setState(Function.State value)

Output only. State of the function.

.google.cloud.functions.v2beta.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)

public Function.Builder setStateMessages(int index, StateMessage value)

Output only. State Messages for this Cloud Function.

repeated .google.cloud.functions.v2beta.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)

public Function.Builder setStateMessages(int index, StateMessage.Builder builderForValue)

Output only. State Messages for this Cloud Function.

repeated .google.cloud.functions.v2beta.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)

public Function.Builder setStateValue(int value)

Output only. State of the function.

.google.cloud.functions.v2beta.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)

public final Function.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Function.Builder
Overrides

setUpdateTime(Timestamp value)

public Function.Builder setUpdateTime(Timestamp value)

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)

public Function.Builder setUpdateTime(Timestamp.Builder builderForValue)

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)

public Function.Builder setUrl(String value)

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)

public Function.Builder setUrlBytes(ByteString value)

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.