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
Static Fields
BUILD_CONFIG_FIELD_NUMBER
public static final int BUILD_CONFIG_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
ENVIRONMENT_FIELD_NUMBER
public static final int ENVIRONMENT_FIELD_NUMBER
Field Value
EVENT_TRIGGER_FIELD_NUMBER
public static final int EVENT_TRIGGER_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
SERVICE_CONFIG_FIELD_NUMBER
public static final int SERVICE_CONFIG_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
STATE_MESSAGES_FIELD_NUMBER
public static final int STATE_MESSAGES_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Function getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Function.Builder newBuilder()
Returns
newBuilder(Function prototype)
public static Function.Builder newBuilder(Function prototype)
Parameter
Returns
public static Function parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Function parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Function parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Function parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Function parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Function parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Function parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Function parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Function parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Function parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Function parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Function parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Function> parser()
Returns
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Labels associated with this Cloud Function.
map<string, string> labels = 8;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
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;
getDefaultInstanceForType()
public Function getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
User-provided description of a function.
string description = 2;
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
User-provided description of a function.
string description = 2;
| Type | Description |
| ByteString | The bytes for description.
|
getEnvironment()
public Environment getEnvironment()
Describe whether the function is gen1 or gen2.
.google.cloud.functions.v2.Environment environment = 10;
getEnvironmentValue()
public int getEnvironmentValue()
Describe whether the function is gen1 or gen2.
.google.cloud.functions.v2.Environment environment = 10;
| 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;
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;
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Labels associated with this Cloud Function.
map<string, string> labels = 8;
getLabelsMap()
public Map<String,String> getLabelsMap()
Labels associated with this Cloud Function.
map<string, string> labels = 8;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Labels associated with this Cloud Function.
map<string, string> labels = 8;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Labels associated with this Cloud Function.
map<string, string> labels = 8;
getName()
A user-defined name of the function. Function names must be unique
globally and match pattern projects/*/locations/*/functions/*
string name = 1;
| 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;
getParserForType()
public Parser<Function> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
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;
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;
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];
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];
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];
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];
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];
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];
| 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];
| Type | Description |
| int | The enum numeric value on the wire for state.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
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];
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;
| Type | Description |
| boolean | Whether the buildConfig 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;
| 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;
| 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];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Function.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Function.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Function.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
