- 2.56.0 (latest)
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.4
- 2.4.3
- 2.3.6
public interface FunctionOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract 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 abstract BuildConfig getBuildConfig()Describes the Build step of the function that builds a container from the given source.
.google.cloud.functions.v2alpha.BuildConfig build_config = 3;
| Returns | |
|---|---|
| Type | Description |
BuildConfig |
The buildConfig. |
getBuildConfigOrBuilder()
public abstract BuildConfigOrBuilder getBuildConfigOrBuilder()Describes the Build step of the function that builds a container from the given source.
.google.cloud.functions.v2alpha.BuildConfig build_config = 3;
| Returns | |
|---|---|
| Type | Description |
BuildConfigOrBuilder |
|
getCreateTime()
public abstract 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 abstract 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 |
|
getDescription()
public abstract String getDescription()User-provided description of a function.
string description = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()User-provided description of a function.
string description = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getEnvironment()
public abstract Environment getEnvironment()Describe whether the function is 1st Gen or 2nd Gen.
.google.cloud.functions.v2alpha.Environment environment = 10;
| Returns | |
|---|---|
| Type | Description |
Environment |
The environment. |
getEnvironmentValue()
public abstract int getEnvironmentValue()Describe whether the function is 1st Gen or 2nd Gen.
.google.cloud.functions.v2alpha.Environment environment = 10;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for environment. |
getEventTrigger()
public abstract EventTrigger getEventTrigger()An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
.google.cloud.functions.v2alpha.EventTrigger event_trigger = 5;
| Returns | |
|---|---|
| Type | Description |
EventTrigger |
The eventTrigger. |
getEventTriggerOrBuilder()
public abstract EventTriggerOrBuilder getEventTriggerOrBuilder()An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
.google.cloud.functions.v2alpha.EventTrigger event_trigger = 5;
| Returns | |
|---|---|
| Type | Description |
EventTriggerOrBuilder |
|
getKmsKeyName()
public abstract 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 abstract 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 abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public abstract int getLabelsCount()Labels associated with this Cloud Function.
map<string, string> labels = 8;
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract ServiceConfig getServiceConfig()Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2alpha.ServiceConfig service_config = 4;
| Returns | |
|---|---|
| Type | Description |
ServiceConfig |
The serviceConfig. |
getServiceConfigOrBuilder()
public abstract ServiceConfigOrBuilder getServiceConfigOrBuilder()Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2alpha.ServiceConfig service_config = 4;
| Returns | |
|---|---|
| Type | Description |
ServiceConfigOrBuilder |
|
getState()
public abstract Function.State getState()Output only. State of the function.
.google.cloud.functions.v2alpha.Function.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Function.State |
The state. |
getStateMessages(int index)
public abstract StateMessage getStateMessages(int index)Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2alpha.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
StateMessage |
|
getStateMessagesCount()
public abstract int getStateMessagesCount()Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2alpha.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getStateMessagesList()
public abstract List<StateMessage> getStateMessagesList()Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2alpha.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<StateMessage> |
|
getStateMessagesOrBuilder(int index)
public abstract StateMessageOrBuilder getStateMessagesOrBuilder(int index)Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2alpha.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
StateMessageOrBuilder |
|
getStateMessagesOrBuilderList()
public abstract List<? extends StateMessageOrBuilder> getStateMessagesOrBuilderList()Output only. State Messages for this Cloud Function.
repeated .google.cloud.functions.v2alpha.StateMessage state_messages = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.functions.v2alpha.StateMessageOrBuilder> |
|
getStateValue()
public abstract int getStateValue()Output only. State of the function.
.google.cloud.functions.v2alpha.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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasBuildConfig()Describes the Build step of the function that builds a container from the given source.
.google.cloud.functions.v2alpha.BuildConfig build_config = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the buildConfig field is set. |
hasCreateTime()
public abstract 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 abstract boolean hasEventTrigger()An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
.google.cloud.functions.v2alpha.EventTrigger event_trigger = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the eventTrigger field is set. |
hasServiceConfig()
public abstract boolean hasServiceConfig()Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
.google.cloud.functions.v2alpha.ServiceConfig service_config = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the serviceConfig field is set. |
hasUpdateTime()
public abstract 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. |