com.google.events.cloud.functions.v2.EventTriggerOrBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-cloudevent-types Show documentation
Types in Java for CloudEvents issued by Google.
There is a newer version: 0.15.0
Show newest version
/*
 * Copyright 2023 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/events/cloud/functions/v2/data.proto

package com.google.events.cloud.functions.v2;

public interface EventTriggerOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.events.cloud.functions.v2.EventTrigger)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Output only. The resource name of the Eventarc trigger. The format of this
   * field is `projects/{project}/locations/{region}/triggers/{trigger}`.
   * 
   *
   * string trigger = 1;
   *
   * @return The trigger.
   */
  java.lang.String getTrigger();
  /**
   *
   *
   *    * Output only. The resource name of the Eventarc trigger. The format of this
   * field is `projects/{project}/locations/{region}/triggers/{trigger}`.
   * 
   *
   * string trigger = 1;
   *
   * @return The bytes for trigger.
   */
  com.google.protobuf.ByteString getTriggerBytes();

  /**
   *
   *
   *    * The region that the trigger will be in. The trigger will only receive
   * events originating in this region. It can be the same
   * region as the function, a different region or multi-region, or the global
   * region. If not provided, defaults to the same region as the function.
   * 
   *
   * string trigger_region = 2;
   *
   * @return The triggerRegion.
   */
  java.lang.String getTriggerRegion();
  /**
   *
   *
   *    * The region that the trigger will be in. The trigger will only receive
   * events originating in this region. It can be the same
   * region as the function, a different region or multi-region, or the global
   * region. If not provided, defaults to the same region as the function.
   * 
   *
   * string trigger_region = 2;
   *
   * @return The bytes for triggerRegion.
   */
  com.google.protobuf.ByteString getTriggerRegionBytes();

  /**
   *
   *
   *    * Required. The type of event to observe. For example:
   * `google.cloud.audit.log.v1.written` or
   * `google.cloud.pubsub.topic.v1.messagePublished`.
   * 
   *
   * string event_type = 3;
   *
   * @return The eventType.
   */
  java.lang.String getEventType();
  /**
   *
   *
   *    * Required. The type of event to observe. For example:
   * `google.cloud.audit.log.v1.written` or
   * `google.cloud.pubsub.topic.v1.messagePublished`.
   * 
   *
   * string event_type = 3;
   *
   * @return The bytes for eventType.
   */
  com.google.protobuf.ByteString getEventTypeBytes();

  /**
   *
   *
   *    * Criteria used to filter events.
   * 
   *
   * repeated .google.events.cloud.functions.v2.EventFilter event_filters = 4;
   */
  java.util.List getEventFiltersList();
  /**
   *
   *
   *    * Criteria used to filter events.
   * 
   *
   * repeated .google.events.cloud.functions.v2.EventFilter event_filters = 4;
   */
  com.google.events.cloud.functions.v2.EventFilter getEventFilters(int index);
  /**
   *
   *
   *    * Criteria used to filter events.
   * 
   *
   * repeated .google.events.cloud.functions.v2.EventFilter event_filters = 4;
   */
  int getEventFiltersCount();
  /**
   *
   *
   *    * Criteria used to filter events.
   * 
   *
   * repeated .google.events.cloud.functions.v2.EventFilter event_filters = 4;
   */
  java.util.List
      getEventFiltersOrBuilderList();
  /**
   *
   *
   *    * Criteria used to filter events.
   * 
   *
   * repeated .google.events.cloud.functions.v2.EventFilter event_filters = 4;
   */
  com.google.events.cloud.functions.v2.EventFilterOrBuilder getEventFiltersOrBuilder(int index);

  /**
   *
   *
   *    * Optional. The name of a Pub/Sub topic in the same project that will be used
   * as the transport topic for the event delivery. Format:
   * `projects/{project}/topics/{topic}`.
   * This is only valid for events of type
   * `google.cloud.pubsub.topic.v1.messagePublished`. The topic provided here
   * will not be deleted at function deletion.
   * 
   *
   * string pubsub_topic = 5;
   *
   * @return The pubsubTopic.
   */
  java.lang.String getPubsubTopic();
  /**
   *
   *
   *    * Optional. The name of a Pub/Sub topic in the same project that will be used
   * as the transport topic for the event delivery. Format:
   * `projects/{project}/topics/{topic}`.
   * This is only valid for events of type
   * `google.cloud.pubsub.topic.v1.messagePublished`. The topic provided here
   * will not be deleted at function deletion.
   * 
   *
   * string pubsub_topic = 5;
   *
   * @return The bytes for pubsubTopic.
   */
  com.google.protobuf.ByteString getPubsubTopicBytes();

  /**
   *
   *
   *    * Optional. The email of the trigger's service account. The service account
   * must have permission to invoke Cloud Run services, the permission is
   * `run.routes.invoke`.
   * If empty, defaults to the Compute Engine default service account:
   * `{project_number}-compute@developer.gserviceaccount.com`.
   * 
   *
   * string service_account_email = 6;
   *
   * @return The serviceAccountEmail.
   */
  java.lang.String getServiceAccountEmail();
  /**
   *
   *
   *    * Optional. The email of the trigger's service account. The service account
   * must have permission to invoke Cloud Run services, the permission is
   * `run.routes.invoke`.
   * If empty, defaults to the Compute Engine default service account:
   * `{project_number}-compute@developer.gserviceaccount.com`.
   * 
   *
   * string service_account_email = 6;
   *
   * @return The bytes for serviceAccountEmail.
   */
  com.google.protobuf.ByteString getServiceAccountEmailBytes();

  /**
   *
   *
   *    * Optional. If unset, then defaults to ignoring failures (i.e. not retrying
   * them).
   * 
   *
   * .google.events.cloud.functions.v2.EventTrigger.RetryPolicy retry_policy = 7;
   *
   * @return The enum numeric value on the wire for retryPolicy.
   */
  int getRetryPolicyValue();
  /**
   *
   *
   *    * Optional. If unset, then defaults to ignoring failures (i.e. not retrying
   * them).
   * 
   *
   * .google.events.cloud.functions.v2.EventTrigger.RetryPolicy retry_policy = 7;
   *
   * @return The retryPolicy.
   */
  com.google.events.cloud.functions.v2.EventTrigger.RetryPolicy getRetryPolicy();

  /**
   *
   *
   *    * Optional. The name of the channel associated with the trigger in
   * `projects/{project}/locations/{location}/channels/{channel}` format.
   * You must provide a channel to receive events from Eventarc SaaS partners.
   * 
   *
   * string channel = 8;
   *
   * @return The channel.
   */
  java.lang.String getChannel();
  /**
   *
   *
   *    * Optional. The name of the channel associated with the trigger in
   * `projects/{project}/locations/{location}/channels/{channel}` format.
   * You must provide a channel to receive events from Eventarc SaaS partners.
   * 
   *
   * string channel = 8;
   *
   * @return The bytes for channel.
   */
  com.google.protobuf.ByteString getChannelBytes();
}