com.google.cloud.eventarc.publishing.v1.CloudEventOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-eventarc-publishing-v1 Show documentation
Proto library for google-cloud-eventarc-publishing
The newest version!
/*
 * Copyright 2024 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/cloud/eventarc/publishing/v1/cloud_event.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.eventarc.publishing.v1;

public interface CloudEventOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.eventarc.publishing.v1.CloudEvent)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. Identifies the event. Producers MUST ensure that source + id is
   * unique for each distinct event.
   * 
   *
   * string id = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The id.
   */
  java.lang.String getId();
  /**
   *
   *
   *    * Required. Identifies the event. Producers MUST ensure that source + id is
   * unique for each distinct event.
   * 
   *
   * string id = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for id.
   */
  com.google.protobuf.ByteString getIdBytes();

  /**
   *
   *
   *    * Required. Identifies the context in which an event happened.
   * URI-reference
   * 
   *
   * string source = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The source.
   */
  java.lang.String getSource();
  /**
   *
   *
   *    * Required. Identifies the context in which an event happened.
   * URI-reference
   * 
   *
   * string source = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for source.
   */
  com.google.protobuf.ByteString getSourceBytes();

  /**
   *
   *
   *    * Required. The version of the CloudEvents specification which the event
   * uses.
   * 
   *
   * string spec_version = 3 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The specVersion.
   */
  java.lang.String getSpecVersion();
  /**
   *
   *
   *    * Required. The version of the CloudEvents specification which the event
   * uses.
   * 
   *
   * string spec_version = 3 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for specVersion.
   */
  com.google.protobuf.ByteString getSpecVersionBytes();

  /**
   *
   *
   *    * Required. This attribute contains a value describing the type of event
   * related to the originating occurrence.
   * 
   *
   * string type = 4 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The type.
   */
  java.lang.String getType();
  /**
   *
   *
   *    * Required. This attribute contains a value describing the type of event
   * related to the originating occurrence.
   * 
   *
   * string type = 4 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for type.
   */
  com.google.protobuf.ByteString getTypeBytes();

  /**
   *
   *
   *    * Optional. Used for Optional & Extension Attributes
   * 
   *
   * 
   * map<string, .google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue> attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  int getAttributesCount();
  /**
   *
   *
   *    * Optional. Used for Optional & Extension Attributes
   * 
   *
   * 
   * map<string, .google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue> attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  boolean containsAttributes(java.lang.String key);
  /** Use {@link #getAttributesMap()} instead. */
  @java.lang.Deprecated
  java.util.Map<
          java.lang.String,
          com.google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue>
      getAttributes();
  /**
   *
   *
   *    * Optional. Used for Optional & Extension Attributes
   * 
   *
   * 
   * map<string, .google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue> attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  java.util.Map<
          java.lang.String,
          com.google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue>
      getAttributesMap();
  /**
   *
   *
   *    * Optional. Used for Optional & Extension Attributes
   * 
   *
   * 
   * map<string, .google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue> attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  /* nullable */
  com.google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue
      getAttributesOrDefault(
          java.lang.String key,
          /* nullable */
          com.google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue defaultValue);
  /**
   *
   *
   *    * Optional. Used for Optional & Extension Attributes
   * 
   *
   * 
   * map<string, .google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue> attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.cloud.eventarc.publishing.v1.CloudEvent.CloudEventAttributeValue getAttributesOrThrow(
      java.lang.String key);

  /**
   *
   *
   *    * Optional. Binary data.
   * 
   *
   * bytes binary_data = 6 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return Whether the binaryData field is set.
   */
  boolean hasBinaryData();
  /**
   *
   *
   *    * Optional. Binary data.
   * 
   *
   * bytes binary_data = 6 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The binaryData.
   */
  com.google.protobuf.ByteString getBinaryData();

  /**
   *
   *
   *    * Optional. Text data.
   * 
   *
   * string text_data = 7 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return Whether the textData field is set.
   */
  boolean hasTextData();
  /**
   *
   *
   *    * Optional. Text data.
   * 
   *
   * string text_data = 7 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The textData.
   */
  java.lang.String getTextData();
  /**
   *
   *
   *    * Optional. Text data.
   * 
   *
   * string text_data = 7 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for textData.
   */
  com.google.protobuf.ByteString getTextDataBytes();

  /**
   *
   *
   *    * Optional. Proto data.
   * 
   *
   * .google.protobuf.Any proto_data = 8 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return Whether the protoData field is set.
   */
  boolean hasProtoData();
  /**
   *
   *
   *    * Optional. Proto data.
   * 
   *
   * .google.protobuf.Any proto_data = 8 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The protoData.
   */
  com.google.protobuf.Any getProtoData();
  /**
   *
   *
   *    * Optional. Proto data.
   * 
   *
   * .google.protobuf.Any proto_data = 8 [(.google.api.field_behavior) = OPTIONAL];
   */
  com.google.protobuf.AnyOrBuilder getProtoDataOrBuilder();

  com.google.cloud.eventarc.publishing.v1.CloudEvent.DataCase getDataCase();
}