Class Webhook.GenericWebService (0.41.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.v3.Webhook.GenericWebService

Inheritance

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

Implements

Webhook.GenericWebServiceOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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`

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`

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

AbstractMessage.equals(Object other)

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 \ -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 int getAllowedCaCertsCount()

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

Returns
Type	Description
`int`	The count of allowedCaCerts.

getAllowedCaCertsList()

public List<ByteString> getAllowedCaCertsList()

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.v3.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.v3.Webhook.GenericWebService.HttpMethod http_method = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The enum numeric value on the wire for httpMethod.

getParameterMapping()

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`

getParserForType()

public Parser<Webhook.GenericWebService> getParserForType()

Returns
Type	Description
`Parser<GenericWebService>`

Overrides

GeneratedMessageV3.getParserForType()

getPassword() (deprecated)

public String getPassword()

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

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.v3.Webhook.GenericWebService.password is deprecated. See google/cloud/dialogflow/cx/v3/webhook.proto;l=150

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

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`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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.v3.Webhook.GenericWebService.username is deprecated. See google/cloud/dialogflow/cx/v3/webhook.proto;l=147

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.v3.Webhook.GenericWebService.username is deprecated. See google/cloud/dialogflow/cx/v3/webhook.proto;l=147

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.v3.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.v3.Webhook.GenericWebService.WebhookType webhook_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The enum numeric value on the wire for webhookType.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`