Class Webhook.GenericWebService.Builder (0.56.0) 

public static final class Webhook.GenericWebService.Builder extends GeneratedMessageV3.Builder<Webhook.GenericWebService.Builder> implements Webhook.GenericWebServiceOrBuilder

Represents configuration for a generic web service.

Protobuf type google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Webhook.GenericWebService.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllAllowedCaCerts(Iterable<? extends ByteString> values)

public Webhook.GenericWebService.Builder addAllAllowedCaCerts(Iterable<? extends ByteString> values)

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 &#92; -signkey example.com.key &#92; -out example.com.crt &#92; -extfile &lt;(printf "&#92;nsubjectAltName='DNS:www.example.com'") </code></code>

repeated bytes allowed_ca_certs = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.protobuf.ByteString>

The allowedCaCerts to add.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

addAllowedCaCerts(ByteString value)

public Webhook.GenericWebService.Builder addAllowedCaCerts(ByteString value)

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 &#92; -signkey example.com.key &#92; -out example.com.crt &#92; -extfile &lt;(printf "&#92;nsubjectAltName='DNS:www.example.com'") </code></code>

repeated bytes allowed_ca_certs = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The allowedCaCerts to add.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Webhook.GenericWebService.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Webhook.GenericWebService.Builder
Overrides

build()

public Webhook.GenericWebService build()
Returns
Type Description
Webhook.GenericWebService

buildPartial()

public Webhook.GenericWebService buildPartial()
Returns
Type Description
Webhook.GenericWebService

clear()

public Webhook.GenericWebService.Builder clear()
Returns
Type Description
Webhook.GenericWebService.Builder
Overrides

clearAllowedCaCerts()

public Webhook.GenericWebService.Builder clearAllowedCaCerts()

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 &#92; -signkey example.com.key &#92; -out example.com.crt &#92; -extfile &lt;(printf "&#92;nsubjectAltName='DNS:www.example.com'") </code></code>

repeated bytes allowed_ca_certs = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Webhook.GenericWebService.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Webhook.GenericWebService.Builder
Overrides

clearHttpMethod()

public Webhook.GenericWebService.Builder clearHttpMethod()

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.Builder

This builder for chaining.

clearOauthConfig()

public Webhook.GenericWebService.Builder clearOauthConfig()

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.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Webhook.GenericWebService.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Webhook.GenericWebService.Builder
Overrides

clearParameterMapping()

public Webhook.GenericWebService.Builder clearParameterMapping()
Returns
Type Description
Webhook.GenericWebService.Builder

clearPassword() (deprecated)

public Webhook.GenericWebService.Builder clearPassword()

Deprecated. google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.password is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=191

The password for HTTP Basic authentication.

string password = 3 [deprecated = true];

Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

clearRequestBody()

public Webhook.GenericWebService.Builder clearRequestBody()

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
Webhook.GenericWebService.Builder

This builder for chaining.

clearRequestHeaders()

public Webhook.GenericWebService.Builder clearRequestHeaders()
Returns
Type Description
Webhook.GenericWebService.Builder

clearServiceAgentAuth()

public Webhook.GenericWebService.Builder clearServiceAgentAuth()

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.Builder

This builder for chaining.

clearUri()

public Webhook.GenericWebService.Builder clearUri()

Required. The webhook URI for receiving POST requests. It must use https protocol.

string uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

clearUsername() (deprecated)

public Webhook.GenericWebService.Builder clearUsername()

Deprecated. google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.username is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=188

The user name for HTTP Basic authentication.

string username = 2 [deprecated = true];

Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

clearWebhookType()

public Webhook.GenericWebService.Builder clearWebhookType()

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.Builder

This builder for chaining.

clone()

public Webhook.GenericWebService.Builder clone()
Returns
Type Description
Webhook.GenericWebService.Builder
Overrides

containsParameterMapping(String key)

public 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 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 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 &#92; -signkey example.com.key &#92; -out example.com.crt &#92; -extfile &lt;(printf "&#92;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 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 &#92; -signkey example.com.key &#92; -out example.com.crt &#92; -extfile &lt;(printf "&#92;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 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 &#92; -signkey example.com.key &#92; -out example.com.crt &#92; -extfile &lt;(printf "&#92;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.

getDefaultInstanceForType()

public Webhook.GenericWebService getDefaultInstanceForType()
Returns
Type Description
Webhook.GenericWebService

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getHttpMethod()

public 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 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.

getMutableParameterMapping() (deprecated)

public Map<String,String> getMutableParameterMapping()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableRequestHeaders() (deprecated)

public Map<String,String> getMutableRequestHeaders()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getOauthConfig()

public 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.

getOauthConfigBuilder()

public Webhook.GenericWebService.OAuthConfig.Builder getOauthConfigBuilder()

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.Builder

getOauthConfigOrBuilder()

public 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 Map<String,String> getParameterMapping()

Use #getParameterMappingMap() instead.

Returns
Type Description
Map<String,String>

getParameterMappingCount()

public 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 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 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 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 String getPassword()

Deprecated. google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.password is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=191

The password for HTTP Basic authentication.

string password = 3 [deprecated = true];

Returns
Type Description
String

The password.

getPasswordBytes() (deprecated)

public ByteString getPasswordBytes()

Deprecated. google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.password is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=191

The password for HTTP Basic authentication.

string password = 3 [deprecated = true];

Returns
Type Description
ByteString

The bytes for password.

getRequestBody()

public 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 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 Map<String,String> getRequestHeaders()

Use #getRequestHeadersMap() instead.

Returns
Type Description
Map<String,String>

getRequestHeadersCount()

public int getRequestHeadersCount()

The HTTP request headers to send together with webhook requests.

map<string, string> request_headers = 4;

Returns
Type Description
int

getRequestHeadersMap()

public 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 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 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 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 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 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 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 String getUsername()

Deprecated. google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.username is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=188

The user name for HTTP Basic authentication.

string username = 2 [deprecated = true];

Returns
Type Description
String

The username.

getUsernameBytes() (deprecated)

public ByteString getUsernameBytes()

Deprecated. google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.username is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=188

The user name for HTTP Basic authentication.

string username = 2 [deprecated = true];

Returns
Type Description
ByteString

The bytes for username.

getWebhookType()

public 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Webhook.GenericWebService other)

public Webhook.GenericWebService.Builder mergeFrom(Webhook.GenericWebService other)
Parameter
Name Description
other Webhook.GenericWebService
Returns
Type Description
Webhook.GenericWebService.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Webhook.GenericWebService.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Webhook.GenericWebService.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Webhook.GenericWebService.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Webhook.GenericWebService.Builder
Overrides

mergeOauthConfig(Webhook.GenericWebService.OAuthConfig value)

public Webhook.GenericWebService.Builder mergeOauthConfig(Webhook.GenericWebService.OAuthConfig value)

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];

Parameter
Name Description
value Webhook.GenericWebService.OAuthConfig
Returns
Type Description
Webhook.GenericWebService.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Webhook.GenericWebService.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Webhook.GenericWebService.Builder
Overrides

putAllParameterMapping(Map<String,String> values)

public Webhook.GenericWebService.Builder putAllParameterMapping(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
Webhook.GenericWebService.Builder

putAllRequestHeaders(Map<String,String> values)

public Webhook.GenericWebService.Builder putAllRequestHeaders(Map<String,String> values)

The HTTP request headers to send together with webhook requests.

map<string, string> request_headers = 4;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Webhook.GenericWebService.Builder

putParameterMapping(String key, String value)

public Webhook.GenericWebService.Builder putParameterMapping(String key, String value)

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
value String
Returns
Type Description
Webhook.GenericWebService.Builder

putRequestHeaders(String key, String value)

public Webhook.GenericWebService.Builder putRequestHeaders(String key, String value)

The HTTP request headers to send together with webhook requests.

map<string, string> request_headers = 4;

Parameters
Name Description
key String
value String
Returns
Type Description
Webhook.GenericWebService.Builder

removeParameterMapping(String key)

public Webhook.GenericWebService.Builder removeParameterMapping(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
Webhook.GenericWebService.Builder

removeRequestHeaders(String key)

public Webhook.GenericWebService.Builder removeRequestHeaders(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
Webhook.GenericWebService.Builder

setAllowedCaCerts(int index, ByteString value)

public Webhook.GenericWebService.Builder setAllowedCaCerts(int index, ByteString value)

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 &#92; -signkey example.com.key &#92; -out example.com.crt &#92; -extfile &lt;(printf "&#92;nsubjectAltName='DNS:www.example.com'") </code></code>

repeated bytes allowed_ca_certs = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.
value ByteString

The allowedCaCerts to set.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Webhook.GenericWebService.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Webhook.GenericWebService.Builder
Overrides

setHttpMethod(Webhook.GenericWebService.HttpMethod value)

public Webhook.GenericWebService.Builder setHttpMethod(Webhook.GenericWebService.HttpMethod value)

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];

Parameter
Name Description
value Webhook.GenericWebService.HttpMethod

The httpMethod to set.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

setHttpMethodValue(int value)

public Webhook.GenericWebService.Builder setHttpMethodValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for httpMethod to set.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

setOauthConfig(Webhook.GenericWebService.OAuthConfig value)

public Webhook.GenericWebService.Builder setOauthConfig(Webhook.GenericWebService.OAuthConfig value)

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];

Parameter
Name Description
value Webhook.GenericWebService.OAuthConfig
Returns
Type Description
Webhook.GenericWebService.Builder

setOauthConfig(Webhook.GenericWebService.OAuthConfig.Builder builderForValue)

public Webhook.GenericWebService.Builder setOauthConfig(Webhook.GenericWebService.OAuthConfig.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Webhook.GenericWebService.OAuthConfig.Builder
Returns
Type Description
Webhook.GenericWebService.Builder

setPassword(String value) (deprecated)

public Webhook.GenericWebService.Builder setPassword(String value)

Deprecated. google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.password is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=191

The password for HTTP Basic authentication.

string password = 3 [deprecated = true];

Parameter
Name Description
value String

The password to set.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

setPasswordBytes(ByteString value) (deprecated)

public Webhook.GenericWebService.Builder setPasswordBytes(ByteString value)

Deprecated. google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.password is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=191

The password for HTTP Basic authentication.

string password = 3 [deprecated = true];

Parameter
Name Description
value ByteString

The bytes for password to set.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Webhook.GenericWebService.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Webhook.GenericWebService.Builder
Overrides

setRequestBody(String value)

public Webhook.GenericWebService.Builder setRequestBody(String value)

Optional. Defines a custom JSON object as request body to send to flexible webhook.

string request_body = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The requestBody to set.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

setRequestBodyBytes(ByteString value)

public Webhook.GenericWebService.Builder setRequestBodyBytes(ByteString value)

Optional. Defines a custom JSON object as request body to send to flexible webhook.

string request_body = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for requestBody to set.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

setServiceAgentAuth(Webhook.GenericWebService.ServiceAgentAuth value)

public Webhook.GenericWebService.Builder setServiceAgentAuth(Webhook.GenericWebService.ServiceAgentAuth value)

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];

Parameter
Name Description
value Webhook.GenericWebService.ServiceAgentAuth

The serviceAgentAuth to set.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

setServiceAgentAuthValue(int value)

public Webhook.GenericWebService.Builder setServiceAgentAuthValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for serviceAgentAuth to set.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Webhook.GenericWebService.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Webhook.GenericWebService.Builder
Overrides

setUri(String value)

public Webhook.GenericWebService.Builder setUri(String value)

Required. The webhook URI for receiving POST requests. It must use https protocol.

string uri = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The uri to set.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

setUriBytes(ByteString value)

public Webhook.GenericWebService.Builder setUriBytes(ByteString value)

Required. The webhook URI for receiving POST requests. It must use https protocol.

string uri = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for uri to set.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

setUsername(String value) (deprecated)

public Webhook.GenericWebService.Builder setUsername(String value)

Deprecated. google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.username is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=188

The user name for HTTP Basic authentication.

string username = 2 [deprecated = true];

Parameter
Name Description
value String

The username to set.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

setUsernameBytes(ByteString value) (deprecated)

public Webhook.GenericWebService.Builder setUsernameBytes(ByteString value)

Deprecated. google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.username is deprecated. See google/cloud/dialogflow/cx/v3beta1/webhook.proto;l=188

The user name for HTTP Basic authentication.

string username = 2 [deprecated = true];

Parameter
Name Description
value ByteString

The bytes for username to set.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

setWebhookType(Webhook.GenericWebService.WebhookType value)

public Webhook.GenericWebService.Builder setWebhookType(Webhook.GenericWebService.WebhookType value)

Optional. Type of the webhook.

.google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.WebhookType webhook_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Webhook.GenericWebService.WebhookType

The webhookType to set.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.

setWebhookTypeValue(int value)

public Webhook.GenericWebService.Builder setWebhookTypeValue(int value)

Optional. Type of the webhook.

.google.cloud.dialogflow.cx.v3beta1.Webhook.GenericWebService.WebhookType webhook_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for webhookType to set.
Returns
Type Description
Webhook.GenericWebService.Builder

This builder for chaining.