com.google.cloud.essentialcontacts.v1.SendTestMessageRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-essential-contacts-v1 Show documentation
Proto library for google-cloud-essential-contacts
There is a newer version: 2.55.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/cloud/essentialcontacts/v1/service.proto

// Protobuf Java Version: 3.25.2
package com.google.cloud.essentialcontacts.v1;

public interface SendTestMessageRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.essentialcontacts.v1.SendTestMessageRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The list of names of the contacts to send a test message to.
   * Format: organizations/{organization_id}/contacts/{contact_id},
   * folders/{folder_id}/contacts/{contact_id} or
   * projects/{project_id}/contacts/{contact_id}
   * 
   *
   * 
   * repeated string contacts = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return A list containing the contacts.
   */
  java.util.List getContactsList();
  /**
   *
   *
   *    * Required. The list of names of the contacts to send a test message to.
   * Format: organizations/{organization_id}/contacts/{contact_id},
   * folders/{folder_id}/contacts/{contact_id} or
   * projects/{project_id}/contacts/{contact_id}
   * 
   *
   * 
   * repeated string contacts = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The count of contacts.
   */
  int getContactsCount();
  /**
   *
   *
   *    * Required. The list of names of the contacts to send a test message to.
   * Format: organizations/{organization_id}/contacts/{contact_id},
   * folders/{folder_id}/contacts/{contact_id} or
   * projects/{project_id}/contacts/{contact_id}
   * 
   *
   * 
   * repeated string contacts = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @param index The index of the element to return.
   * @return The contacts at the given index.
   */
  java.lang.String getContacts(int index);
  /**
   *
   *
   *    * Required. The list of names of the contacts to send a test message to.
   * Format: organizations/{organization_id}/contacts/{contact_id},
   * folders/{folder_id}/contacts/{contact_id} or
   * projects/{project_id}/contacts/{contact_id}
   * 
   *
   * 
   * repeated string contacts = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @param index The index of the value to return.
   * @return The bytes of the contacts at the given index.
   */
  com.google.protobuf.ByteString getContactsBytes(int index);

  /**
   *
   *
   *    * Required. The name of the resource to send the test message for. All
   * contacts must either be set directly on this resource or inherited from
   * another resource that is an ancestor of this one. Format:
   * organizations/{organization_id}, folders/{folder_id} or
   * projects/{project_id}
   * 
   *
   * 
   * string resource = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The resource.
   */
  java.lang.String getResource();
  /**
   *
   *
   *    * Required. The name of the resource to send the test message for. All
   * contacts must either be set directly on this resource or inherited from
   * another resource that is an ancestor of this one. Format:
   * organizations/{organization_id}, folders/{folder_id} or
   * projects/{project_id}
   * 
   *
   * 
   * string resource = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for resource.
   */
  com.google.protobuf.ByteString getResourceBytes();

  /**
   *
   *
   *    * Required. The notification category to send the test message for. All
   * contacts must be subscribed to this category.
   * 
   *
   * 
   * .google.cloud.essentialcontacts.v1.NotificationCategory notification_category = 3 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The enum numeric value on the wire for notificationCategory.
   */
  int getNotificationCategoryValue();
  /**
   *
   *
   *    * Required. The notification category to send the test message for. All
   * contacts must be subscribed to this category.
   * 
   *
   * 
   * .google.cloud.essentialcontacts.v1.NotificationCategory notification_category = 3 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The notificationCategory.
   */
  com.google.cloud.essentialcontacts.v1.NotificationCategory getNotificationCategory();
}