Class Function (2.50.0)

public final class Function extends GeneratedMessageV3 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.v2.Function

Implements

FunctionOrBuilder

Static Fields

BUILD_CONFIG_FIELD_NUMBER

public static final int BUILD_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ENVIRONMENT_FIELD_NUMBER

public static final int ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

EVENT_TRIGGER_FIELD_NUMBER

public static final int EVENT_TRIGGER_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_CONFIG_FIELD_NUMBER

public static final int SERVICE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

STATE_MESSAGES_FIELD_NUMBER

public static final int STATE_MESSAGES_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

URL_FIELD_NUMBER

public static final int URL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Function getDefaultInstance()
Returns
Type Description
Function

getDescriptor()

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

newBuilder()

public static Function.Builder newBuilder()
Returns
Type Description
Function.Builder

newBuilder(Function prototype)

public static Function.Builder newBuilder(Function prototype)
Parameter
Name Description
prototype Function
Returns
Type Description
Function.Builder

parseDelimitedFrom(InputStream input)

public static Function parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Function
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Function parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Function
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Function parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Function
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Function parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Function
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Function parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Function
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Function parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Function
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Function parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Function
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Function parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Function
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Function parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Function
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Function parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Function
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Function parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Function
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Function parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Function
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Function> parser()
Returns
Type Description
Parser<Function>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBuildConfig()

public BuildConfig getBuildConfig()

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

public BuildConfigOrBuilder getBuildConfigOrBuilder()

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

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.

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.

getEnvironment()

public Environment getEnvironment()

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

.google.cloud.functions.v2.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.v2.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.v2.EventTrigger event_trigger = 5;

Returns
Type Description
EventTrigger

The eventTrigger.

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.v2.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

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.

getParserForType()

public Parser<Function> getParserForType()
Returns
Type Description
Parser<Function>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceConfig()

public ServiceConfig getServiceConfig()

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

public ServiceConfigOrBuilder getServiceConfigOrBuilder()

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

public Function.State getState()

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)

public StateMessage getStateMessages(int index)

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

getStateMessagesCount()

public int getStateMessagesCount()

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

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

public StateMessageOrBuilder getStateMessagesOrBuilder(int index)

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

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

public int getStateValue()

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

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.

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.v2.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.v2.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.v2.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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Function.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Function.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException