Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class GenericWebService.
Represents configuration for a generic web service.
Dialogflow supports two mechanisms for authentications:
- Basic authentication with username and password.
- Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure.
Generated from protobuf message google.cloud.dialogflow.v2.Fulfillment.GenericWebService
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ uri |
string
Required. The fulfillment URI for receiving POST requests. It must use https protocol. |
↳ username |
string
Optional. The user name for HTTP Basic authentication. |
↳ password |
string
Optional. The password for HTTP Basic authentication. |
↳ request_headers |
array|Google\Protobuf\Internal\MapField
Optional. The HTTP request headers to send together with fulfillment requests. |
↳ is_cloud_function |
bool
Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now. |
getUri
Required. The fulfillment URI for receiving POST requests.
It must use https protocol.
Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setUri
Required. The fulfillment URI for receiving POST requests.
It must use https protocol.
Generated from protobuf field string uri = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUsername
Optional. The user name for HTTP Basic authentication.
Generated from protobuf field string username = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setUsername
Optional. The user name for HTTP Basic authentication.
Generated from protobuf field string username = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPassword
Optional. The password for HTTP Basic authentication.
Generated from protobuf field string password = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setPassword
Optional. The password for HTTP Basic authentication.
Generated from protobuf field string password = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequestHeaders
Optional. The HTTP request headers to send together with fulfillment requests.
Generated from protobuf field map<string, string> request_headers = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setRequestHeaders
Optional. The HTTP request headers to send together with fulfillment requests.
Generated from protobuf field map<string, string> request_headers = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIsCloudFunction
Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false.
is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
Generated from protobuf field bool is_cloud_function = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
bool | |
setIsCloudFunction
Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false.
is_cloud_function is deprecated. Cloud functions can be configured by its uri as a regular web service now.
Generated from protobuf field bool is_cloud_function = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |