Struct google_api_proto::google::cloud::dialogflow::cx::v3::webhook::GenericWebService

pub struct GenericWebService {
    pub uri: String,
    pub username: String,
    pub password: String,
    pub request_headers: BTreeMap<String, String>,
    pub allowed_ca_certs: Vec<Bytes>,
    pub oauth_config: Option<OAuthConfig>,
    pub service_agent_auth: i32,
    pub webhook_type: i32,
    pub http_method: i32,
    pub request_body: String,
    pub parameter_mapping: BTreeMap<String, String>,
}

Represents configuration for a generic web service.

Fields

uri: String

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

username: String

👎Deprecated

The user name for HTTP Basic authentication.

password: String

👎Deprecated

The password for HTTP Basic authentication.

request_headers: BTreeMap<String, String>

The HTTP request headers to send together with webhook requests.

allowed_ca_certs: Vec<Bytes>

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'")

oauth_config: Option<OAuthConfig>

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.

service_agent_auth: i32

Optional. Indicate the auth token type generated from the Diglogflow service agent. The generated token is sent in the Authorization header.

webhook_type: i32

Optional. Type of the webhook.

http_method: i32

Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.

request_body: String

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

parameter_mapping: BTreeMap<String, String>

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

Implementations

impl GenericWebService

pub fn webhook_type(&self) -> WebhookType

Returns the enum value of webhook_type, or the default if the field is set to an invalid enum value.

pub fn set_webhook_type(&mut self, value: WebhookType)

Sets webhook_type to the provided enum value.

pub fn http_method(&self) -> HttpMethod

Returns the enum value of http_method, or the default if the field is set to an invalid enum value.

pub fn set_http_method(&mut self, value: HttpMethod)

Sets http_method to the provided enum value.

pub fn service_agent_auth(&self) -> ServiceAgentAuth

Returns the enum value of service_agent_auth, or the default if the field is set to an invalid enum value.

pub fn set_service_agent_auth(&mut self, value: ServiceAgentAuth)

Sets service_agent_auth to the provided enum value.

Trait Implementations

impl Clone for GenericWebService

fn clone(&self) -> GenericWebService

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GenericWebService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GenericWebService

fn default() -> Self

Returns the “default value” for a type.

impl Message for GenericWebService

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for GenericWebService

fn eq(&self, other: &GenericWebService) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GenericWebService