Interface FunctionOrBuilder (2.13.0)

publicinterface FunctionOrBuilderextendsMessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

publicabstractbooleancontainsLabels(Stringkey)

Labels associated with this Cloud Function.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description

getBuildConfig()

publicabstractBuildConfiggetBuildConfig()

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.

getBuildConfigOrBuilder()

publicabstractBuildConfigOrBuildergetBuildConfigOrBuilder()

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

getDescription()

publicabstractStringgetDescription()

User-provided description of a function.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

publicabstractByteStringgetDescriptionBytes()

User-provided description of a function.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getEnvironment()

publicabstractEnvironmentgetEnvironment()

Describe whether the function is gen1 or gen2.

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

Returns
Type Description
Environment

The environment.

getEnvironmentValue()

publicabstractintgetEnvironmentValue()

Describe whether the function is gen1 or gen2.

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

Returns
Type Description
int

The enum numeric value on the wire for environment.

getEventTrigger()

publicabstractEventTriggergetEventTrigger()

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.

getEventTriggerOrBuilder()

publicabstractEventTriggerOrBuildergetEventTriggerOrBuilder()

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

getLabels()

publicabstractMap<String,String>getLabels()

Use #getLabelsMap() instead.

Returns
Type Description

getLabelsCount()

publicabstractintgetLabelsCount()

Labels associated with this Cloud Function.

map<string, string> labels = 8;

Returns
Type Description
int

getLabelsMap()

publicabstractMap<String,String>getLabelsMap()

Labels associated with this Cloud Function.

map<string, string> labels = 8;

Returns
Type Description

getLabelsOrDefault(String key, String defaultValue)

publicabstractStringgetLabelsOrDefault(Stringkey,StringdefaultValue)

Labels associated with this Cloud Function.

map<string, string> labels = 8;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description

getLabelsOrThrow(String key)

publicabstractStringgetLabelsOrThrow(Stringkey)

Labels associated with this Cloud Function.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description

getName()

publicabstractStringgetName()

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

publicabstractByteStringgetNameBytes()

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

publicabstractServiceConfiggetServiceConfig()

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.

getServiceConfigOrBuilder()

publicabstractServiceConfigOrBuildergetServiceConfigOrBuilder()

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

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

Returns
Type Description

getState()

publicabstractFunction.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)

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

getStateMessagesCount()

publicabstractintgetStateMessagesCount()

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

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

getStateMessagesOrBuilder(int index)

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

getStateMessagesOrBuilderList()

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

publicabstractintgetStateValue()

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

publicabstractTimestampgetUpdateTime()

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

publicabstractTimestampOrBuildergetUpdateTimeOrBuilder()

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

hasBuildConfig()

publicabstractbooleanhasBuildConfig()

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

publicabstractbooleanhasEventTrigger()

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

publicabstractbooleanhasServiceConfig()

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

publicabstractbooleanhasUpdateTime()

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.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.