Package com.google.cloud.dialogflow.cx.v3

Class Webhook.GenericWebService

  • All Implemented Interfaces:
    Webhook.GenericWebServiceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    Webhook
    public static final class Webhook.GenericWebService
extends com.google.protobuf.GeneratedMessageV3
implements Webhook.GenericWebServiceOrBuilder
     Represents configuration for a generic web service.
    Protobuf type google.cloud.dialogflow.cx.v3.Webhook.GenericWebService
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        getUri in interface Webhook.GenericWebServiceOrBuilder
        Returns:
        The uri.

      • getUriBytes

        public com.google.protobuf.ByteString getUriBytes()
         Required. The webhook URI for receiving POST requests. It must use https
 protocol.
        string uri = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getUriBytes in interface Webhook.GenericWebServiceOrBuilder
        Returns:
        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];
        Specified by:
        getUsername in interface Webhook.GenericWebServiceOrBuilder
        Returns:
        The username.

      • getUsernameBytes

        @Deprecated
public com.google.protobuf.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];
        Specified by:
        getUsernameBytes in interface Webhook.GenericWebServiceOrBuilder
        Returns:
        The bytes for username.

      • 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];
        Specified by:
        getPassword in interface Webhook.GenericWebServiceOrBuilder
        Returns:
        The password.

      • getPasswordBytes

        @Deprecated
public com.google.protobuf.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];
        Specified by:
        getPasswordBytes in interface Webhook.GenericWebServiceOrBuilder
        Returns:
        The bytes for password.

      • getAllowedCaCertsList

        public List<com.google.protobuf.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,
 ```
    openssl x509 -req -days 200 -in example.com.csr \
      -signkey example.com.key \
      -out example.com.crt \
      -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
 ```
        repeated bytes allowed_ca_certs = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAllowedCaCertsList in interface Webhook.GenericWebServiceOrBuilder
        Returns:
        A list containing the allowedCaCerts.

      • 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,
 ```
    openssl x509 -req -days 200 -in example.com.csr \
      -signkey example.com.key \
      -out example.com.crt \
      -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
 ```
        repeated bytes allowed_ca_certs = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAllowedCaCertsCount in interface Webhook.GenericWebServiceOrBuilder
        Returns:
        The count of allowedCaCerts.

      • getAllowedCaCerts

        public com.google.protobuf.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,
 ```
    openssl x509 -req -days 200 -in example.com.csr \
      -signkey example.com.key \
      -out example.com.crt \
      -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
 ```
        repeated bytes allowed_ca_certs = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAllowedCaCerts in interface Webhook.GenericWebServiceOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The allowedCaCerts at the given index.

      • 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];
        Specified by:
        getWebhookTypeValue in interface Webhook.GenericWebServiceOrBuilder
        Returns:
        The enum numeric value on the wire for webhookType.

      • 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];
        Specified by:
        getHttpMethodValue in interface Webhook.GenericWebServiceOrBuilder
        Returns:
        The enum numeric value on the wire for httpMethod.

      • 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];
        Specified by:
        getRequestBody in interface Webhook.GenericWebServiceOrBuilder
        Returns:
        The requestBody.

      • getRequestBodyBytes

        public com.google.protobuf.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];
        Specified by:
        getRequestBodyBytes in interface Webhook.GenericWebServiceOrBuilder
        Returns:
        The bytes for requestBody.

      • getParameterMappingCount

        public int getParameterMappingCount()
        Description copied from interface: Webhook.GenericWebServiceOrBuilder
         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];
        Specified by:
        getParameterMappingCount in interface Webhook.GenericWebServiceOrBuilder

      • containsParameterMapping

        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];
        Specified by:
        containsParameterMapping in interface Webhook.GenericWebServiceOrBuilder

      • 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];
        Specified by:
        getParameterMappingMap in interface Webhook.GenericWebServiceOrBuilder

      • getParameterMappingOrDefault

        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];
        Specified by:
        getParameterMappingOrDefault in interface Webhook.GenericWebServiceOrBuilder

      • getParameterMappingOrThrow

        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];
        Specified by:
        getParameterMappingOrThrow in interface Webhook.GenericWebServiceOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Webhook.GenericWebService parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Webhook.GenericWebService parseFrom​(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Webhook.GenericWebService parseFrom​(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Webhook.GenericWebService parseFrom​(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Webhook.GenericWebService parseFrom​(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Webhook.GenericWebService parseFrom​(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public Webhook.GenericWebService.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Webhook.GenericWebService.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Webhook.GenericWebService.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<Webhook.GenericWebService> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Webhook.GenericWebService getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder