com.google.cloud.dialogflow.cx.v3beta1.WebhookOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-cx-v3beta1 Show documentation
PROTO library for proto-google-cloud-dialogflow-cx-v3beta1
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/dialogflow/cx/v3beta1/webhook.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.cx.v3beta1;

public interface WebhookOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.Webhook)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * The unique identifier of the webhook.
   * Required for the
   * [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3beta1.Webhooks.UpdateWebhook]
   * method.
   * [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3beta1.Webhooks.CreateWebhook]
   * populates the name automatically. Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
   * 
   *
   * string name = 1;
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * The unique identifier of the webhook.
   * Required for the
   * [Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3beta1.Webhooks.UpdateWebhook]
   * method.
   * [Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3beta1.Webhooks.CreateWebhook]
   * populates the name automatically. Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
   * 
   *
   * string name = 1;
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Required. The human-readable name of the webhook, unique within the agent.
   * 
   *
   * string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The displayName.
   */
  java.lang.String getDisplayName();
  /**
   *
   *
   *    * Required. The human-readable name of the webhook, unique within the agent.
   * 
   *
   * string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   *    * Configuration for a generic web service.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService generic_web_service = 4;
   * 
   *
   * @return Whether the genericWebService field is set.
   */
  boolean hasGenericWebService();
  /**
   *
   *
   *    * Configuration for a generic web service.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService generic_web_service = 4;
   * 
   *
   * @return The genericWebService.
   */
  com.google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService getGenericWebService();
  /**
   *
   *
   *    * Configuration for a generic web service.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService generic_web_service = 4;
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebServiceOrBuilder
      getGenericWebServiceOrBuilder();

  /**
   *
   *
   *    * Configuration for a [Service
   * Directory](https://cloud.google.com/service-directory) service.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Webhook.ServiceDirectoryConfig service_directory = 7;
   * 
   *
   * @return Whether the serviceDirectory field is set.
   */
  boolean hasServiceDirectory();
  /**
   *
   *
   *    * Configuration for a [Service
   * Directory](https://cloud.google.com/service-directory) service.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Webhook.ServiceDirectoryConfig service_directory = 7;
   * 
   *
   * @return The serviceDirectory.
   */
  com.google.cloud.dialogflow.cx.v3beta1.Webhook.ServiceDirectoryConfig getServiceDirectory();
  /**
   *
   *
   *    * Configuration for a [Service
   * Directory](https://cloud.google.com/service-directory) service.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Webhook.ServiceDirectoryConfig service_directory = 7;
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.Webhook.ServiceDirectoryConfigOrBuilder
      getServiceDirectoryOrBuilder();

  /**
   *
   *
   *    * Webhook execution timeout. Execution is considered failed if Dialogflow
   * doesn't receive a response from webhook at the end of the timeout period.
   * Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
   * 
   *
   * .google.protobuf.Duration timeout = 6;
   *
   * @return Whether the timeout field is set.
   */
  boolean hasTimeout();
  /**
   *
   *
   *    * Webhook execution timeout. Execution is considered failed if Dialogflow
   * doesn't receive a response from webhook at the end of the timeout period.
   * Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
   * 
   *
   * .google.protobuf.Duration timeout = 6;
   *
   * @return The timeout.
   */
  com.google.protobuf.Duration getTimeout();
  /**
   *
   *
   *    * Webhook execution timeout. Execution is considered failed if Dialogflow
   * doesn't receive a response from webhook at the end of the timeout period.
   * Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
   * 
   *
   * .google.protobuf.Duration timeout = 6;
   */
  com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder();

  /**
   *
   *
   *    * Indicates whether the webhook is disabled.
   * 
   *
   * bool disabled = 5;
   *
   * @return The disabled.
   */
  boolean getDisabled();

  com.google.cloud.dialogflow.cx.v3beta1.Webhook.WebhookCase getWebhookCase();
}