- 0.65.0 (latest)
- 0.64.0
- 0.63.0
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.7
- 0.13.1
- 0.12.1
- 0.11.5
public static interface Webhook.GenericWebServiceOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
containsParameterMapping(String key)
public abstract 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];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
boolean |
containsRequestHeaders(String key)
public abstract boolean containsRequestHeaders(String key)
The HTTP request headers to send together with webhook requests.
map<string, string> request_headers = 4;
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
boolean |
getAllowedCaCerts(int index)
public abstract 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,
<code><code>
openssl x509 -req -days 200 -in example.com.csr \
-signkey example.com.key \
-out example.com.crt \
-extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
</code></code>
repeated bytes allowed_ca_certs = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int The index of the element to return. |
Returns | |
---|---|
Type | Description |
ByteString |
The allowedCaCerts at the given index. |
getAllowedCaCertsCount()
public abstract 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,
<code><code>
openssl x509 -req -days 200 -in example.com.csr \
-signkey example.com.key \
-out example.com.crt \
-extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
</code></code>
repeated bytes allowed_ca_certs = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The count of allowedCaCerts. |
getAllowedCaCertsList()
public abstract List<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,
<code><code>
openssl x509 -req -days 200 -in example.com.csr \
-signkey example.com.key \
-out example.com.crt \
-extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
</code></code>
repeated bytes allowed_ca_certs = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<ByteString> |
A list containing the allowedCaCerts. |
getHttpMethod()
public abstract 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 | |
---|---|
Type | Description |
Webhook.GenericWebService.HttpMethod |
The httpMethod. |
getHttpMethodValue()
public abstract 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 | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for httpMethod. |
getOauthConfig()
public abstract 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 | |
---|---|
Type | Description |
Webhook.GenericWebService.OAuthConfig |
The oauthConfig. |
getOauthConfigOrBuilder()
public abstract 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];
Returns | |
---|---|
Type | Description |
Webhook.GenericWebService.OAuthConfigOrBuilder |
getParameterMapping() (deprecated)
public abstract Map<String,String> getParameterMapping()
Use #getParameterMappingMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getParameterMappingCount()
public abstract 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];
Returns | |
---|---|
Type | Description |
int |
getParameterMappingMap()
public abstract 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];
Returns | |
---|---|
Type | Description |
Map<String,String> |
getParameterMappingOrDefault(String key, String defaultValue)
public abstract 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];
Parameters | |
---|---|
Name | Description |
key |
String |
defaultValue |
String |
Returns | |
---|---|
Type | Description |
String |
getParameterMappingOrThrow(String key)
public abstract 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];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
String |
getPassword() (deprecated)
public abstract String getPassword()
Deprecated. google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.password is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=190
The password for HTTP Basic authentication.
string password = 3 [deprecated = true];
Returns | |
---|---|
Type | Description |
String |
The password. |
getPasswordBytes() (deprecated)
public abstract ByteString getPasswordBytes()
Deprecated. google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.password is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=190
The password for HTTP Basic authentication.
string password = 3 [deprecated = true];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for password. |
getRequestBody()
public abstract 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 | |
---|---|
Type | Description |
String |
The requestBody. |
getRequestBodyBytes()
public abstract 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 | |
---|---|
Type | Description |
ByteString |
The bytes for requestBody. |
getRequestHeaders() (deprecated)
public abstract Map<String,String> getRequestHeaders()
Use #getRequestHeadersMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getRequestHeadersCount()
public abstract int getRequestHeadersCount()
The HTTP request headers to send together with webhook requests.
map<string, string> request_headers = 4;
Returns | |
---|---|
Type | Description |
int |
getRequestHeadersMap()
public abstract Map<String,String> getRequestHeadersMap()
The HTTP request headers to send together with webhook requests.
map<string, string> request_headers = 4;
Returns | |
---|---|
Type | Description |
Map<String,String> |
getRequestHeadersOrDefault(String key, String defaultValue)
public abstract String getRequestHeadersOrDefault(String key, String defaultValue)
The HTTP request headers to send together with webhook requests.
map<string, string> request_headers = 4;
Parameters | |
---|---|
Name | Description |
key |
String |
defaultValue |
String |
Returns | |
---|---|
Type | Description |
String |
getRequestHeadersOrThrow(String key)
public abstract String getRequestHeadersOrThrow(String key)
The HTTP request headers to send together with webhook requests.
map<string, string> request_headers = 4;
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
String |
getServiceAgentAuth()
public abstract Webhook.GenericWebService.ServiceAgentAuth getServiceAgentAuth()
Optional. Indicate the auth token type generated from the Diglogflow 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 | |
---|---|
Type | Description |
Webhook.GenericWebService.ServiceAgentAuth |
The serviceAgentAuth. |
getServiceAgentAuthValue()
public abstract int getServiceAgentAuthValue()
Optional. Indicate the auth token type generated from the Diglogflow 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 | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for serviceAgentAuth. |
getUri()
public abstract String getUri()
Required. The webhook URI for receiving POST requests. It must use https protocol.
string uri = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String |
The uri. |
getUriBytes()
public abstract ByteString getUriBytes()
Required. The webhook URI for receiving POST requests. It must use https protocol.
string uri = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for uri. |
getUsername() (deprecated)
public abstract String getUsername()
Deprecated. google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.username is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=187
The user name for HTTP Basic authentication.
string username = 2 [deprecated = true];
Returns | |
---|---|
Type | Description |
String |
The username. |
getUsernameBytes() (deprecated)
public abstract ByteString getUsernameBytes()
Deprecated. google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.username is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=187
The user name for HTTP Basic authentication.
string username = 2 [deprecated = true];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for username. |
getWebhookType()
public abstract 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 | |
---|---|
Type | Description |
Webhook.GenericWebService.WebhookType |
The webhookType. |
getWebhookTypeValue()
public abstract int getWebhookTypeValue()
Optional. Type of the webhook.
.google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.WebhookType webhook_type = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for webhookType. |
hasOauthConfig()
public abstract 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 | |
---|---|
Type | Description |
boolean |
Whether the oauthConfig field is set. |