Package com.google.cloud.functions.v2

Interface FunctionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Function, Function.Builder
@Generated public interface FunctionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • getDescription

      String getDescription()
       User-provided description of a function.
      string description = 2;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       User-provided description of a function.
      string description = 2;
      Returns:
      The bytes for description.

    • hasBuildConfig

      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:
      Whether the buildConfig field is set.

    • getBuildConfig

      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:
      The buildConfig.

    • getBuildConfigOrBuilder

      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;

    • hasServiceConfig

      boolean hasServiceConfig()
       Describes the Service being deployed. Currently deploys services to Cloud
 Run (fully managed).
      .google.cloud.functions.v2.ServiceConfig service_config = 4;
      Returns:
      Whether the serviceConfig field is set.

    • getServiceConfig

      ServiceConfig getServiceConfig()
       Describes the Service being deployed. Currently deploys services to Cloud
 Run (fully managed).
      .google.cloud.functions.v2.ServiceConfig service_config = 4;
      Returns:
      The serviceConfig.

    • getServiceConfigOrBuilder

      ServiceConfigOrBuilder getServiceConfigOrBuilder()
       Describes the Service being deployed. Currently deploys services to Cloud
 Run (fully managed).
      .google.cloud.functions.v2.ServiceConfig service_config = 4;

    • hasEventTrigger

      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:
      Whether the eventTrigger field is set.

    • getEventTrigger

      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:
      The eventTrigger.

    • getEventTriggerOrBuilder

      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;

    • getStateValue

      int getStateValue()
       Output only. State of the function.
      .google.cloud.functions.v2.Function.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Function.State getState()
       Output only. State of the function.
      .google.cloud.functions.v2.Function.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • hasUpdateTime

      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:
      Whether the updateTime field is set.

    • getUpdateTime

      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];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      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];

    • getLabelsCount

      int getLabelsCount()
       Labels associated with this Cloud Function.
      map<string, string> labels = 8;

    • containsLabels

      boolean containsLabels(String key)
       Labels associated with this Cloud Function.
      map<string, string> labels = 8;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Labels associated with this Cloud Function.
      map<string, string> labels = 8;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Labels associated with this Cloud Function.
      map<string, string> labels = 8;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Labels associated with this Cloud Function.
      map<string, string> labels = 8;

    • getStateMessagesList

      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];

    • getStateMessages

      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

      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];

    • getStateMessagesOrBuilderList

      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];

    • getStateMessagesOrBuilder

      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];

    • getEnvironmentValue

      int getEnvironmentValue()
       Describe whether the function is 1st Gen or 2nd Gen.
      .google.cloud.functions.v2.Environment environment = 10;
      Returns:
      The enum numeric value on the wire for environment.

    • getEnvironment

      Environment getEnvironment()
       Describe whether the function is 1st Gen or 2nd Gen.
      .google.cloud.functions.v2.Environment environment = 10;
      Returns:
      The environment.

    • getUrl

      String getUrl()
       Output only. The deployed url for the function.
      string url = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The url.

    • getUrlBytes

      com.google.protobuf.ByteString getUrlBytes()
       Output only. The deployed url for the function.
      string url = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for url.

    • getKmsKeyName

      String getKmsKeyName()
       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:
      The kmsKeyName.

    • getKmsKeyNameBytes

      com.google.protobuf.ByteString getKmsKeyNameBytes()
       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:
      The bytes for kmsKeyName.

    • getSatisfiesPzs

      boolean getSatisfiesPzs()
       Output only. Reserved for future use.
      bool satisfies_pzs = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The satisfiesPzs.

    • hasCreateTime

      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:
      Whether the createTime field is set.

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      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];