public final class Function extends com.google.protobuf.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.v2beta.Function| Modifier and Type | Class and Description |
|---|---|
static class |
Function.Builder
Describes a Cloud Function that contains user computation executed in
response to an event.
|
static class |
Function.State
Describes the current state of the function.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
BUILD_CONFIG_FIELD_NUMBER |
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
ENVIRONMENT_FIELD_NUMBER |
static int |
EVENT_TRIGGER_FIELD_NUMBER |
static int |
KMS_KEY_NAME_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
SATISFIES_PZS_FIELD_NUMBER |
static int |
SERVICE_CONFIG_FIELD_NUMBER |
static int |
STATE_FIELD_NUMBER |
static int |
STATE_MESSAGES_FIELD_NUMBER |
static int |
UPDATE_TIME_FIELD_NUMBER |
static int |
URL_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
Labels associated with this Cloud Function.
|
boolean |
equals(Object obj) |
BuildConfig |
getBuildConfig()
Describes the Build step of the function that builds a container from the
given source.
|
BuildConfigOrBuilder |
getBuildConfigOrBuilder()
Describes the Build step of the function that builds a container from the
given source.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static Function |
getDefaultInstance() |
Function |
getDefaultInstanceForType() |
String |
getDescription()
User-provided description of a function.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
User-provided description of a function.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
Environment |
getEnvironment()
Describe whether the function is 1st Gen or 2nd Gen.
|
int |
getEnvironmentValue()
Describe whether the function is 1st Gen or 2nd Gen.
|
EventTrigger |
getEventTrigger()
An Eventarc trigger managed by Google Cloud Functions that fires events in
response to a condition in another service.
|
EventTriggerOrBuilder |
getEventTriggerOrBuilder()
An Eventarc trigger managed by Google Cloud Functions that fires events in
response to a condition in another service.
|
String |
getKmsKeyName()
[Preview] Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt function resources.
|
com.google.protobuf.ByteString |
getKmsKeyNameBytes()
[Preview] Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt function resources.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
Labels associated with this Cloud Function.
|
Map<String,String> |
getLabelsMap()
Labels associated with this Cloud Function.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
Labels associated with this Cloud Function.
|
String |
getLabelsOrThrow(String key)
Labels associated with this Cloud Function.
|
String |
getName()
A user-defined name of the function.
|
com.google.protobuf.ByteString |
getNameBytes()
A user-defined name of the function.
|
com.google.protobuf.Parser<Function> |
getParserForType() |
boolean |
getSatisfiesPzs()
Output only.
|
int |
getSerializedSize() |
ServiceConfig |
getServiceConfig()
Describes the Service being deployed.
|
ServiceConfigOrBuilder |
getServiceConfigOrBuilder()
Describes the Service being deployed.
|
Function.State |
getState()
Output only.
|
StateMessage |
getStateMessages(int index)
Output only.
|
int |
getStateMessagesCount()
Output only.
|
List<StateMessage> |
getStateMessagesList()
Output only.
|
StateMessageOrBuilder |
getStateMessagesOrBuilder(int index)
Output only.
|
List<? extends StateMessageOrBuilder> |
getStateMessagesOrBuilderList()
Output only.
|
int |
getStateValue()
Output only.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
String |
getUrl()
Output only.
|
com.google.protobuf.ByteString |
getUrlBytes()
Output only.
|
boolean |
hasBuildConfig()
Describes the Build step of the function that builds a container from the
given source.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasEventTrigger()
An Eventarc trigger managed by Google Cloud Functions that fires events in
response to a condition in another service.
|
int |
hashCode() |
boolean |
hasServiceConfig()
Describes the Service being deployed.
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
boolean |
isInitialized() |
static Function.Builder |
newBuilder() |
static Function.Builder |
newBuilder(Function prototype) |
Function.Builder |
newBuilderForType() |
protected Function.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Function |
parseDelimitedFrom(InputStream input) |
static Function |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Function |
parseFrom(byte[] data) |
static Function |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Function |
parseFrom(ByteBuffer data) |
static Function |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Function |
parseFrom(com.google.protobuf.ByteString data) |
static Function |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Function |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Function |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Function |
parseFrom(InputStream input) |
static Function |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Function> |
parser() |
Function.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int BUILD_CONFIG_FIELD_NUMBER
public static final int SERVICE_CONFIG_FIELD_NUMBER
public static final int EVENT_TRIGGER_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int STATE_MESSAGES_FIELD_NUMBER
public static final int ENVIRONMENT_FIELD_NUMBER
public static final int URL_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER
public static final int SATISFIES_PZS_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`
string name = 1;getName in interface FunctionOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`
string name = 1;getNameBytes in interface FunctionOrBuilderpublic String getDescription()
User-provided description of a function.
string description = 2;getDescription in interface FunctionOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
User-provided description of a function.
string description = 2;getDescriptionBytes in interface FunctionOrBuilderpublic 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;hasBuildConfig in interface FunctionOrBuilderpublic 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;getBuildConfig in interface FunctionOrBuilderpublic 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;getBuildConfigOrBuilder in interface FunctionOrBuilderpublic boolean hasServiceConfig()
Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2beta.ServiceConfig service_config = 4;hasServiceConfig in interface FunctionOrBuilderpublic ServiceConfig getServiceConfig()
Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2beta.ServiceConfig service_config = 4;getServiceConfig in interface FunctionOrBuilderpublic ServiceConfigOrBuilder getServiceConfigOrBuilder()
Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2beta.ServiceConfig service_config = 4;getServiceConfigOrBuilder in interface FunctionOrBuilderpublic 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;hasEventTrigger in interface FunctionOrBuilderpublic 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;getEventTrigger in interface FunctionOrBuilderpublic 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;getEventTriggerOrBuilder in interface FunctionOrBuilderpublic int getStateValue()
Output only. State of the function.
.google.cloud.functions.v2beta.Function.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface FunctionOrBuilderpublic Function.State getState()
Output only. State of the function.
.google.cloud.functions.v2beta.Function.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState in interface FunctionOrBuilderpublic boolean hasUpdateTime()
Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface FunctionOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface FunctionOrBuilderpublic com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last update timestamp of a Cloud Function.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface FunctionOrBuilderpublic int getLabelsCount()
FunctionOrBuilderLabels associated with this Cloud Function.
map<string, string> labels = 8;getLabelsCount in interface FunctionOrBuilderpublic boolean containsLabels(String key)
Labels associated with this Cloud Function.
map<string, string> labels = 8;containsLabels in interface FunctionOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface FunctionOrBuilderpublic Map<String,String> getLabelsMap()
Labels associated with this Cloud Function.
map<string, string> labels = 8;getLabelsMap in interface FunctionOrBuilderpublic String getLabelsOrDefault(String key, String defaultValue)
Labels associated with this Cloud Function.
map<string, string> labels = 8;getLabelsOrDefault in interface FunctionOrBuilderpublic String getLabelsOrThrow(String key)
Labels associated with this Cloud Function.
map<string, string> labels = 8;getLabelsOrThrow in interface FunctionOrBuilderpublic 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];
getStateMessagesList in interface FunctionOrBuilderpublic 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];
getStateMessagesOrBuilderList in interface FunctionOrBuilderpublic 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];
getStateMessagesCount in interface FunctionOrBuilderpublic 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];
getStateMessages in interface FunctionOrBuilderpublic 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];
getStateMessagesOrBuilder in interface FunctionOrBuilderpublic int getEnvironmentValue()
Describe whether the function is 1st Gen or 2nd Gen.
.google.cloud.functions.v2beta.Environment environment = 10;getEnvironmentValue in interface FunctionOrBuilderpublic Environment getEnvironment()
Describe whether the function is 1st Gen or 2nd Gen.
.google.cloud.functions.v2beta.Environment environment = 10;getEnvironment in interface FunctionOrBuilderpublic String getUrl()
Output only. The deployed url for the function.
string url = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];getUrl in interface FunctionOrBuilderpublic com.google.protobuf.ByteString getUrlBytes()
Output only. The deployed url for the function.
string url = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];getUrlBytes in interface FunctionOrBuilderpublic 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) = { ... }getKmsKeyName in interface FunctionOrBuilderpublic com.google.protobuf.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) = { ... }getKmsKeyNameBytes in interface FunctionOrBuilderpublic boolean getSatisfiesPzs()
Output only. Reserved for future use.
bool satisfies_pzs = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];getSatisfiesPzs in interface FunctionOrBuilderpublic 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];
hasCreateTime in interface FunctionOrBuilderpublic com.google.protobuf.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];
getCreateTime in interface FunctionOrBuilderpublic com.google.protobuf.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];
getCreateTimeOrBuilder in interface FunctionOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Function parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Function parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Function parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Function parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Function parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Function parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Function parseFrom(InputStream input) throws IOException
IOExceptionpublic static Function parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Function parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Function parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Function parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Function parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Function.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Function.Builder newBuilder()
public static Function.Builder newBuilder(Function prototype)
public Function.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Function.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Function getDefaultInstance()
public static com.google.protobuf.Parser<Function> parser()
public com.google.protobuf.Parser<Function> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Function getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.