com.google.storage.v2.NotificationConfigOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-storage-v2 Show documentation
PROTO library for proto-google-cloud-storage-v2
There is a newer version: 2.47.0
Show 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/storage/v2/storage.proto

// Protobuf Java Version: 3.25.2
package com.google.storage.v2;

public interface NotificationConfigOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.storage.v2.NotificationConfig)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The resource name of this NotificationConfig.
   * Format:
   * `projects/{project}/buckets/{bucket}/notificationConfigs/{notificationConfig}`
   * The `{project}` portion may be `_` for globally unique buckets.
   * 
   *
   * string name = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * Required. The resource name of this NotificationConfig.
   * Format:
   * `projects/{project}/buckets/{bucket}/notificationConfigs/{notificationConfig}`
   * The `{project}` portion may be `_` for globally unique buckets.
   * 
   *
   * string name = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Required. The Pub/Sub topic to which this subscription publishes. Formatted
   * as:
   * '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
   * 
   *
   * string topic = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The topic.
   */
  java.lang.String getTopic();
  /**
   *
   *
   *    * Required. The Pub/Sub topic to which this subscription publishes. Formatted
   * as:
   * '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
   * 
   *
   * string topic = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for topic.
   */
  com.google.protobuf.ByteString getTopicBytes();

  /**
   *
   *
   *    * The etag of the NotificationConfig.
   * If included in the metadata of GetNotificationConfigRequest, the operation
   * will only be performed if the etag matches that of the NotificationConfig.
   * 
   *
   * string etag = 7;
   *
   * @return The etag.
   */
  java.lang.String getEtag();
  /**
   *
   *
   *    * The etag of the NotificationConfig.
   * If included in the metadata of GetNotificationConfigRequest, the operation
   * will only be performed if the etag matches that of the NotificationConfig.
   * 
   *
   * string etag = 7;
   *
   * @return The bytes for etag.
   */
  com.google.protobuf.ByteString getEtagBytes();

  /**
   *
   *
   *    * If present, only send notifications about listed event types. If
   * empty, sent notifications for all event types.
   * 
   *
   * repeated string event_types = 3;
   *
   * @return A list containing the eventTypes.
   */
  java.util.List getEventTypesList();
  /**
   *
   *
   *    * If present, only send notifications about listed event types. If
   * empty, sent notifications for all event types.
   * 
   *
   * repeated string event_types = 3;
   *
   * @return The count of eventTypes.
   */
  int getEventTypesCount();
  /**
   *
   *
   *    * If present, only send notifications about listed event types. If
   * empty, sent notifications for all event types.
   * 
   *
   * repeated string event_types = 3;
   *
   * @param index The index of the element to return.
   * @return The eventTypes at the given index.
   */
  java.lang.String getEventTypes(int index);
  /**
   *
   *
   *    * If present, only send notifications about listed event types. If
   * empty, sent notifications for all event types.
   * 
   *
   * repeated string event_types = 3;
   *
   * @param index The index of the value to return.
   * @return The bytes of the eventTypes at the given index.
   */
  com.google.protobuf.ByteString getEventTypesBytes(int index);

  /**
   *
   *
   *    * A list of additional attributes to attach to each Pub/Sub
   * message published for this NotificationConfig.
   * 
   *
   * map<string, string> custom_attributes = 4;
   */
  int getCustomAttributesCount();
  /**
   *
   *
   *    * A list of additional attributes to attach to each Pub/Sub
   * message published for this NotificationConfig.
   * 
   *
   * map<string, string> custom_attributes = 4;
   */
  boolean containsCustomAttributes(java.lang.String key);
  /** Use {@link #getCustomAttributesMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getCustomAttributes();
  /**
   *
   *
   *    * A list of additional attributes to attach to each Pub/Sub
   * message published for this NotificationConfig.
   * 
   *
   * map<string, string> custom_attributes = 4;
   */
  java.util.Map getCustomAttributesMap();
  /**
   *
   *
   *    * A list of additional attributes to attach to each Pub/Sub
   * message published for this NotificationConfig.
   * 
   *
   * map<string, string> custom_attributes = 4;
   */
  /* nullable */
  java.lang.String getCustomAttributesOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.String defaultValue);
  /**
   *
   *
   *    * A list of additional attributes to attach to each Pub/Sub
   * message published for this NotificationConfig.
   * 
   *
   * map<string, string> custom_attributes = 4;
   */
  java.lang.String getCustomAttributesOrThrow(java.lang.String key);

  /**
   *
   *
   *    * If present, only apply this NotificationConfig to object names that
   * begin with this prefix.
   * 
   *
   * string object_name_prefix = 5;
   *
   * @return The objectNamePrefix.
   */
  java.lang.String getObjectNamePrefix();
  /**
   *
   *
   *    * If present, only apply this NotificationConfig to object names that
   * begin with this prefix.
   * 
   *
   * string object_name_prefix = 5;
   *
   * @return The bytes for objectNamePrefix.
   */
  com.google.protobuf.ByteString getObjectNamePrefixBytes();

  /**
   *
   *
   *    * Required. The desired content of the Payload.
   * 
   *
   * string payload_format = 6 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The payloadFormat.
   */
  java.lang.String getPayloadFormat();
  /**
   *
   *
   *    * Required. The desired content of the Payload.
   * 
   *
   * string payload_format = 6 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for payloadFormat.
   */
  com.google.protobuf.ByteString getPayloadFormatBytes();
}