Class Webhook.GenericWebService (0.57.0)

public static final class Webhook.GenericWebService extends GeneratedMessageV3 implements Webhook.GenericWebServiceOrBuilder

Represents configuration for a generic web service.

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

Static Fields

ALLOWED_CA_CERTS_FIELD_NUMBER

public static final int ALLOWED_CA_CERTS_FIELD_NUMBER
Field Value
Type Description
int

HTTP_METHOD_FIELD_NUMBER

public static final int HTTP_METHOD_FIELD_NUMBER
Field Value
Type Description
int

OAUTH_CONFIG_FIELD_NUMBER

public static final int OAUTH_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PARAMETER_MAPPING_FIELD_NUMBER

public static final int PARAMETER_MAPPING_FIELD_NUMBER
Field Value
Type Description
int

PASSWORD_FIELD_NUMBER

public static final int PASSWORD_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_BODY_FIELD_NUMBER

public static final int REQUEST_BODY_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_HEADERS_FIELD_NUMBER

public static final int REQUEST_HEADERS_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_AGENT_AUTH_FIELD_NUMBER

public static final int SERVICE_AGENT_AUTH_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

USERNAME_FIELD_NUMBER

public static final int USERNAME_FIELD_NUMBER
Field Value
Type Description
int

WEBHOOK_TYPE_FIELD_NUMBER

public static final int WEBHOOK_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Webhook.GenericWebService getDefaultInstance()
Returns
Type Description
Webhook.GenericWebService

getDescriptor()

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

newBuilder()

public static Webhook.GenericWebService.Builder newBuilder()
Returns
Type Description
Webhook.GenericWebService.Builder

newBuilder(Webhook.GenericWebService prototype)

public static Webhook.GenericWebService.Builder newBuilder(Webhook.GenericWebService prototype)
Parameter
Name Description
prototype Webhook.GenericWebService
Returns
Type Description
Webhook.GenericWebService.Builder

parseDelimitedFrom(InputStream input)

public static Webhook.GenericWebService parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Webhook.GenericWebService
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Webhook.GenericWebService parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Webhook.GenericWebService
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Webhook.GenericWebService parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Webhook.GenericWebService
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Webhook.GenericWebService parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Webhook.GenericWebService
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Webhook.GenericWebService parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Webhook.GenericWebService
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Webhook.GenericWebService parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Webhook.GenericWebService
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Webhook.GenericWebService parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Webhook.GenericWebService
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Webhook.GenericWebService parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Webhook.GenericWebService
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Webhook.GenericWebService parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Webhook.GenericWebService
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Webhook.GenericWebService parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Webhook.GenericWebService
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Webhook.GenericWebService parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Webhook.GenericWebService
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Webhook.GenericWebService parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Webhook.GenericWebService
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Webhook.GenericWebService> parser()
Returns
Type Description
Parser<GenericWebService>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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.

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.

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()
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

getParserForType()

public Parser<Webhook.GenericWebService> getParserForType()
Returns
Type Description
Parser<GenericWebService>
Overrides

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()
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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Webhook.GenericWebService.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Webhook.GenericWebService.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException