com.google.shopping.merchant.notifications.v1beta.NotificationSubscriptionOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-shopping-merchant-notifications-v1beta Show documentation
Proto library for google-shopping-merchant-notifications
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/shopping/merchant/notifications/v1beta/notificationsapi.proto

// Protobuf Java Version: 3.25.3
package com.google.shopping.merchant.notifications.v1beta;

public interface NotificationSubscriptionOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.shopping.merchant.notifications.v1beta.NotificationSubscription)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * If this value is true, the requesting account is notified of the
   * specified event for all managed accounts (can be subaccounts or other
   * linked accounts) including newly added accounts on a daily basis.
   * 
   *
   * bool all_managed_accounts = 3;
   *
   * @return Whether the allManagedAccounts field is set.
   */
  boolean hasAllManagedAccounts();
  /**
   *
   *
   *    * If this value is true, the requesting account is notified of the
   * specified event for all managed accounts (can be subaccounts or other
   * linked accounts) including newly added accounts on a daily basis.
   * 
   *
   * bool all_managed_accounts = 3;
   *
   * @return The allManagedAccounts.
   */
  boolean getAllManagedAccounts();

  /**
   *
   *
   *    * The `name` of the account you want to receive notifications for.
   * Format: `accounts/{account}`
   * 
   *
   * string target_account = 4;
   *
   * @return Whether the targetAccount field is set.
   */
  boolean hasTargetAccount();
  /**
   *
   *
   *    * The `name` of the account you want to receive notifications for.
   * Format: `accounts/{account}`
   * 
   *
   * string target_account = 4;
   *
   * @return The targetAccount.
   */
  java.lang.String getTargetAccount();
  /**
   *
   *
   *    * The `name` of the account you want to receive notifications for.
   * Format: `accounts/{account}`
   * 
   *
   * string target_account = 4;
   *
   * @return The bytes for targetAccount.
   */
  com.google.protobuf.ByteString getTargetAccountBytes();

  /**
   *
   *
   *    * Output only. The `name` of the notification configuration. Generated by the
   * Content API upon creation of a new `NotificationSubscription`. The
   * `account` represents the merchant ID of the merchant that owns the
   * configuration. Format:
   * `accounts/{account}/notificationsubscriptions/{notification_subscription}`
   * 
   *
   * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * Output only. The `name` of the notification configuration. Generated by the
   * Content API upon creation of a new `NotificationSubscription`. The
   * `account` represents the merchant ID of the merchant that owns the
   * configuration. Format:
   * `accounts/{account}/notificationsubscriptions/{notification_subscription}`
   * 
   *
   * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * The event that the merchant wants to be notified about.
   * 
   *
   * 
   * .google.shopping.merchant.notifications.v1beta.NotificationSubscription.NotificationEventType registered_event = 2;
   * 
   *
   * @return The enum numeric value on the wire for registeredEvent.
   */
  int getRegisteredEventValue();
  /**
   *
   *
   *    * The event that the merchant wants to be notified about.
   * 
   *
   * 
   * .google.shopping.merchant.notifications.v1beta.NotificationSubscription.NotificationEventType registered_event = 2;
   * 
   *
   * @return The registeredEvent.
   */
  com.google.shopping.merchant.notifications.v1beta.NotificationSubscription.NotificationEventType
      getRegisteredEvent();

  /**
   *
   *
   *    * URL to be used to push the notification to the merchant.
   * 
   *
   * string call_back_uri = 5;
   *
   * @return The callBackUri.
   */
  java.lang.String getCallBackUri();
  /**
   *
   *
   *    * URL to be used to push the notification to the merchant.
   * 
   *
   * string call_back_uri = 5;
   *
   * @return The bytes for callBackUri.
   */
  com.google.protobuf.ByteString getCallBackUriBytes();

  com.google.shopping.merchant.notifications.v1beta.NotificationSubscription.InterestedInCase
      getInterestedInCase();
}