Class Webhook.GenericWebService (0.44.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
TypeDescription
int

HTTP_METHOD_FIELD_NUMBER

public static final int HTTP_METHOD_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETER_MAPPING_FIELD_NUMBER

public static final int PARAMETER_MAPPING_FIELD_NUMBER
Field Value
TypeDescription
int

PASSWORD_FIELD_NUMBER

public static final int PASSWORD_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_BODY_FIELD_NUMBER

public static final int REQUEST_BODY_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_HEADERS_FIELD_NUMBER

public static final int REQUEST_HEADERS_FIELD_NUMBER
Field Value
TypeDescription
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
TypeDescription
int

USERNAME_FIELD_NUMBER

public static final int USERNAME_FIELD_NUMBER
Field Value
TypeDescription
int

WEBHOOK_TYPE_FIELD_NUMBER

public static final int WEBHOOK_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Webhook.GenericWebService getDefaultInstance()
Returns
TypeDescription
Webhook.GenericWebService

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Webhook.GenericWebService.Builder newBuilder()
Returns
TypeDescription
Webhook.GenericWebService.Builder

newBuilder(Webhook.GenericWebService prototype)

public static Webhook.GenericWebService.Builder newBuilder(Webhook.GenericWebService prototype)
Parameter
NameDescription
prototypeWebhook.GenericWebService
Returns
TypeDescription
Webhook.GenericWebService.Builder

parseDelimitedFrom(InputStream input)

public static Webhook.GenericWebService parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Webhook.GenericWebService
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Webhook.GenericWebService parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Webhook.GenericWebService
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Webhook.GenericWebService parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Webhook.GenericWebService
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Webhook.GenericWebService parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Webhook.GenericWebService
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Webhook.GenericWebService parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Webhook.GenericWebService
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Webhook.GenericWebService parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Webhook.GenericWebService
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Webhook.GenericWebService parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Webhook.GenericWebService
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Webhook.GenericWebService parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Webhook.GenericWebService
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Webhook.GenericWebService parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Webhook.GenericWebService
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Webhook.GenericWebService parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Webhook.GenericWebService
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Webhook.GenericWebService parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Webhook.GenericWebService
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Webhook.GenericWebService parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Webhook.GenericWebService
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Webhook.GenericWebService> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
List<ByteString>

A list containing the allowedCaCerts.

getDefaultInstanceForType()

public Webhook.GenericWebService getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for httpMethod.

getParameterMapping() (deprecated)

public Map<String,String> getParameterMapping()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getParserForType()

public Parser<Webhook.GenericWebService> getParserForType()
Returns
TypeDescription
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=150

The password for HTTP Basic authentication.

string password = 3 [deprecated = true];

Returns
TypeDescription
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=150

The password for HTTP Basic authentication.

string password = 3 [deprecated = true];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for requestBody.

getRequestHeaders() (deprecated)

public Map<String,String> getRequestHeaders()
Returns
TypeDescription
Map<String,String>

getRequestHeadersCount()

public int getRequestHeadersCount()

The HTTP request headers to send together with webhook requests.

map<string, string> request_headers = 4;

Returns
TypeDescription
int

getRequestHeadersMap()

public Map<String,String> getRequestHeadersMap()

The HTTP request headers to send together with webhook requests.

map<string, string> request_headers = 4;

Returns
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
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
TypeDescription
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=147

The user name for HTTP Basic authentication.

string username = 2 [deprecated = true];

Returns
TypeDescription
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=147

The user name for HTTP Basic authentication.

string username = 2 [deprecated = true];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for webhookType.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Webhook.GenericWebService.Builder newBuilderForType()
Returns
TypeDescription
Webhook.GenericWebService.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Webhook.GenericWebService.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Webhook.GenericWebService.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Webhook.GenericWebService.Builder toBuilder()
Returns
TypeDescription
Webhook.GenericWebService.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException