Package com.google.cloud.dialogflow.cx.v3beta1

Interface Webhook.GenericWebServiceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Webhook.GenericWebService, Webhook.GenericWebService.Builder
Enclosing class:
Webhook
public static interface Webhook.GenericWebServiceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getUri

      String getUri()
       Required. The webhook URI for receiving POST requests. It must use https
 protocol.
      string uri = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The uri.

    • getUriBytes

      com.google.protobuf.ByteString getUriBytes()
       Required. The webhook URI for receiving POST requests. It must use https
 protocol.
      string uri = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for uri.

    • getUsername

      @Deprecated String getUsername()
      Deprecated.
      google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.username is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=225
       The user name for HTTP Basic authentication.
      string username = 2 [deprecated = true];
      Returns:
      The username.

    • getUsernameBytes

      @Deprecated com.google.protobuf.ByteString getUsernameBytes()
      Deprecated.
      google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.username is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=225
       The user name for HTTP Basic authentication.
      string username = 2 [deprecated = true];
      Returns:
      The bytes for username.

    • getPassword

      @Deprecated String getPassword()
      Deprecated.
      google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.password is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=228
       The password for HTTP Basic authentication.
      string password = 3 [deprecated = true];
      Returns:
      The password.

    • getPasswordBytes

      @Deprecated com.google.protobuf.ByteString getPasswordBytes()
      Deprecated.
      google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.password is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=228
       The password for HTTP Basic authentication.
      string password = 3 [deprecated = true];
      Returns:
      The bytes for password.

    • getSecretVersionForUsernamePassword

      String getSecretVersionForUsernamePassword()
       Optional. The SecretManager secret version resource storing the
 username:password pair for HTTP Basic authentication. Format:
 `projects/{project}/secrets/{secret}/versions/{version}`
      string secret_version_for_username_password = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The secretVersionForUsernamePassword.

    • getSecretVersionForUsernamePasswordBytes

      com.google.protobuf.ByteString getSecretVersionForUsernamePasswordBytes()
       Optional. The SecretManager secret version resource storing the
 username:password pair for HTTP Basic authentication. Format:
 `projects/{project}/secrets/{secret}/versions/{version}`
      string secret_version_for_username_password = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for secretVersionForUsernamePassword.

    • getRequestHeadersCount

      int getRequestHeadersCount()
       The HTTP request headers to send together with webhook requests.
      map<string, string> request_headers = 4;

    • containsRequestHeaders

      boolean containsRequestHeaders(String key)
       The HTTP request headers to send together with webhook requests.
      map<string, string> request_headers = 4;

    • getRequestHeaders

      @Deprecated Map<String,String> getRequestHeaders()
      Deprecated.
      Use getRequestHeadersMap() instead.

    • getRequestHeadersMap

      Map<String,String> getRequestHeadersMap()
       The HTTP request headers to send together with webhook requests.
      map<string, string> request_headers = 4;

    • getRequestHeadersOrDefault

      String getRequestHeadersOrDefault(String key, String defaultValue)
       The HTTP request headers to send together with webhook requests.
      map<string, string> request_headers = 4;

    • getRequestHeadersOrThrow

      String getRequestHeadersOrThrow(String key)
       The HTTP request headers to send together with webhook requests.
      map<string, string> request_headers = 4;

    • getSecretVersionsForRequestHeadersCount

      int getSecretVersionsForRequestHeadersCount()
       Optional. The HTTP request headers to send together with webhook
 requests. Header values are stored in SecretManager secret versions.

 When the same header name is specified in both `request_headers` and
 `secret_versions_for_request_headers`, the value in
 `secret_versions_for_request_headers` will be used.
      map<string, .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.SecretVersionHeaderValue> secret_versions_for_request_headers = 20 [(.google.api.field_behavior) = OPTIONAL];

    • containsSecretVersionsForRequestHeaders

      boolean containsSecretVersionsForRequestHeaders(String key)
       Optional. The HTTP request headers to send together with webhook
 requests. Header values are stored in SecretManager secret versions.

 When the same header name is specified in both `request_headers` and
 `secret_versions_for_request_headers`, the value in
 `secret_versions_for_request_headers` will be used.
      map<string, .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.SecretVersionHeaderValue> secret_versions_for_request_headers = 20 [(.google.api.field_behavior) = OPTIONAL];

    • getSecretVersionsForRequestHeaders

      @Deprecated Map<String,Webhook.GenericWebService.SecretVersionHeaderValue> getSecretVersionsForRequestHeaders()
      Deprecated.
      Use getSecretVersionsForRequestHeadersMap() instead.

    • getSecretVersionsForRequestHeadersMap

      Map<String,Webhook.GenericWebService.SecretVersionHeaderValue> getSecretVersionsForRequestHeadersMap()
       Optional. The HTTP request headers to send together with webhook
 requests. Header values are stored in SecretManager secret versions.

 When the same header name is specified in both `request_headers` and
 `secret_versions_for_request_headers`, the value in
 `secret_versions_for_request_headers` will be used.
      map<string, .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.SecretVersionHeaderValue> secret_versions_for_request_headers = 20 [(.google.api.field_behavior) = OPTIONAL];

    • getSecretVersionsForRequestHeadersOrDefault

      Webhook.GenericWebService.SecretVersionHeaderValue getSecretVersionsForRequestHeadersOrDefault(String key, Webhook.GenericWebService.SecretVersionHeaderValue defaultValue)
       Optional. The HTTP request headers to send together with webhook
 requests. Header values are stored in SecretManager secret versions.

 When the same header name is specified in both `request_headers` and
 `secret_versions_for_request_headers`, the value in
 `secret_versions_for_request_headers` will be used.
      map<string, .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.SecretVersionHeaderValue> secret_versions_for_request_headers = 20 [(.google.api.field_behavior) = OPTIONAL];

    • getSecretVersionsForRequestHeadersOrThrow

      Webhook.GenericWebService.SecretVersionHeaderValue getSecretVersionsForRequestHeadersOrThrow(String key)
       Optional. The HTTP request headers to send together with webhook
 requests. Header values are stored in SecretManager secret versions.

 When the same header name is specified in both `request_headers` and
 `secret_versions_for_request_headers`, the value in
 `secret_versions_for_request_headers` will be used.
      map<string, .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.SecretVersionHeaderValue> secret_versions_for_request_headers = 20 [(.google.api.field_behavior) = OPTIONAL];

    • getAllowedCaCertsList

      List<com.google.protobuf.ByteString> getAllowedCaCertsList()
       Optional. Specifies a list of allowed custom CA certificates (in DER
 format) for HTTPS verification. This overrides the default SSL trust
 store. If this is empty or unspecified, Dialogflow will use Google's
 default trust store to verify certificates. N.B. Make sure the HTTPS
 server certificates are signed with "subject alt name". For instance a
 certificate can be self-signed using the following command,
 ```
 openssl x509 -req -days 200 -in example.com.csr \
 -signkey example.com.key \
 -out example.com.crt \
 -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
 ```
      repeated bytes allowed_ca_certs = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the allowedCaCerts.

    • getAllowedCaCertsCount

      int getAllowedCaCertsCount()
       Optional. Specifies a list of allowed custom CA certificates (in DER
 format) for HTTPS verification. This overrides the default SSL trust
 store. If this is empty or unspecified, Dialogflow will use Google's
 default trust store to verify certificates. N.B. Make sure the HTTPS
 server certificates are signed with "subject alt name". For instance a
 certificate can be self-signed using the following command,
 ```
 openssl x509 -req -days 200 -in example.com.csr \
 -signkey example.com.key \
 -out example.com.crt \
 -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
 ```
      repeated bytes allowed_ca_certs = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of allowedCaCerts.

    • getAllowedCaCerts

      com.google.protobuf.ByteString getAllowedCaCerts(int index)
       Optional. Specifies a list of allowed custom CA certificates (in DER
 format) for HTTPS verification. This overrides the default SSL trust
 store. If this is empty or unspecified, Dialogflow will use Google's
 default trust store to verify certificates. N.B. Make sure the HTTPS
 server certificates are signed with "subject alt name". For instance a
 certificate can be self-signed using the following command,
 ```
 openssl x509 -req -days 200 -in example.com.csr \
 -signkey example.com.key \
 -out example.com.crt \
 -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
 ```
      repeated bytes allowed_ca_certs = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The allowedCaCerts at the given index.

    • hasOauthConfig

      boolean hasOauthConfig()
       Optional. The OAuth configuration of the webhook. If specified,
 Dialogflow will initiate the OAuth client credential flow to exchange an
 access token from the 3rd party platform and put it in the auth header.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.OAuthConfig oauth_config = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the oauthConfig field is set.

    • getOauthConfig

      Webhook.GenericWebService.OAuthConfig getOauthConfig()
       Optional. The OAuth configuration of the webhook. If specified,
 Dialogflow will initiate the OAuth client credential flow to exchange an
 access token from the 3rd party platform and put it in the auth header.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.OAuthConfig oauth_config = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The oauthConfig.

    • getOauthConfigOrBuilder

      Webhook.GenericWebService.OAuthConfigOrBuilder getOauthConfigOrBuilder()
       Optional. The OAuth configuration of the webhook. If specified,
 Dialogflow will initiate the OAuth client credential flow to exchange an
 access token from the 3rd party platform and put it in the auth header.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.OAuthConfig oauth_config = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getServiceAgentAuthValue

      int getServiceAgentAuthValue()
       Optional. Indicate the auth token type generated from the [Diglogflow
 service
 agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
 The generated token is sent in the Authorization header.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.ServiceAgentAuth service_agent_auth = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for serviceAgentAuth.

    • getServiceAgentAuth

      Webhook.GenericWebService.ServiceAgentAuth getServiceAgentAuth()
       Optional. Indicate the auth token type generated from the [Diglogflow
 service
 agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
 The generated token is sent in the Authorization header.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.ServiceAgentAuth service_agent_auth = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The serviceAgentAuth.

    • hasServiceAccountAuthConfig

      boolean hasServiceAccountAuthConfig()
       Optional. Configuration for service account authentication.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.ServiceAccountAuthConfig service_account_auth_config = 18 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the serviceAccountAuthConfig field is set.

    • getServiceAccountAuthConfig

      Webhook.GenericWebService.ServiceAccountAuthConfig getServiceAccountAuthConfig()
       Optional. Configuration for service account authentication.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.ServiceAccountAuthConfig service_account_auth_config = 18 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The serviceAccountAuthConfig.

    • getServiceAccountAuthConfigOrBuilder

      Webhook.GenericWebService.ServiceAccountAuthConfigOrBuilder getServiceAccountAuthConfigOrBuilder()
       Optional. Configuration for service account authentication.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.ServiceAccountAuthConfig service_account_auth_config = 18 [(.google.api.field_behavior) = OPTIONAL];

    • getWebhookTypeValue

      int getWebhookTypeValue()
       Optional. Type of the webhook.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.WebhookType webhook_type = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for webhookType.

    • getWebhookType

      Webhook.GenericWebService.WebhookType getWebhookType()
       Optional. Type of the webhook.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.WebhookType webhook_type = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The webhookType.

    • getHttpMethodValue

      int getHttpMethodValue()
       Optional. HTTP method for the flexible webhook calls. Standard webhook
 always uses POST.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.HttpMethod http_method = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for httpMethod.

    • getHttpMethod

      Webhook.GenericWebService.HttpMethod getHttpMethod()
       Optional. HTTP method for the flexible webhook calls. Standard webhook
 always uses POST.
      .google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.HttpMethod http_method = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The httpMethod.

    • getRequestBody

      String getRequestBody()
       Optional. Defines a custom JSON object as request body to send to
 flexible webhook.
      string request_body = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The requestBody.

    • getRequestBodyBytes

      com.google.protobuf.ByteString getRequestBodyBytes()
       Optional. Defines a custom JSON object as request body to send to
 flexible webhook.
      string request_body = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for requestBody.

    • getParameterMappingCount

      int getParameterMappingCount()
       Optional. Maps the values extracted from specific fields of the flexible
 webhook response into session parameters.
 - Key: session parameter name
 - Value: field path in the webhook response
      map<string, string> parameter_mapping = 9 [(.google.api.field_behavior) = OPTIONAL];

    • containsParameterMapping

      boolean containsParameterMapping(String key)
       Optional. Maps the values extracted from specific fields of the flexible
 webhook response into session parameters.
 - Key: session parameter name
 - Value: field path in the webhook response
      map<string, string> parameter_mapping = 9 [(.google.api.field_behavior) = OPTIONAL];

    • getParameterMapping

      @Deprecated Map<String,String> getParameterMapping()
      Deprecated.
      Use getParameterMappingMap() instead.

    • getParameterMappingMap

      Map<String,String> getParameterMappingMap()
       Optional. Maps the values extracted from specific fields of the flexible
 webhook response into session parameters.
 - Key: session parameter name
 - Value: field path in the webhook response
      map<string, string> parameter_mapping = 9 [(.google.api.field_behavior) = OPTIONAL];

    • getParameterMappingOrDefault

      String getParameterMappingOrDefault(String key, String defaultValue)
       Optional. Maps the values extracted from specific fields of the flexible
 webhook response into session parameters.
 - Key: session parameter name
 - Value: field path in the webhook response
      map<string, string> parameter_mapping = 9 [(.google.api.field_behavior) = OPTIONAL];

    • getParameterMappingOrThrow

      String getParameterMappingOrThrow(String key)
       Optional. Maps the values extracted from specific fields of the flexible
 webhook response into session parameters.
 - Key: session parameter name
 - Value: field path in the webhook response
      map<string, string> parameter_mapping = 9 [(.google.api.field_behavior) = OPTIONAL];