Google Cloud Dialogflow V2 Client - Class ReloadDocumentRequest (1.11.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ReloadDocumentRequest.

Request message for Documents.ReloadDocument.

Generated from protobuf message google.cloud.dialogflow.v2.ReloadDocumentRequest

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the document to reload. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>

↳ content_uri string

Optional. The path of gcs source file for reloading document content. For now, only gcs uri is supported. For documents stored in Google Cloud Storage, these URIs must have the form gs://<bucket-name>/<object-name>.

↳ import_gcs_custom_metadata bool

Optional. Whether to import custom metadata from Google Cloud Storage. Only valid when the document source is Google Cloud Storage URI.

↳ smart_messaging_partial_update bool

Optional. When enabled, the reload request is to apply partial update to the smart messaging allowlist.

getName

Required. The name of the document to reload.

Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>

Returns
TypeDescription
string

setName

Required. The name of the document to reload.

Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getContentUri

Optional. The path of gcs source file for reloading document content. For now, only gcs uri is supported.

For documents stored in Google Cloud Storage, these URIs must have the form gs://<bucket-name>/<object-name>.

Returns
TypeDescription
string

hasContentUri

setContentUri

Optional. The path of gcs source file for reloading document content. For now, only gcs uri is supported.

For documents stored in Google Cloud Storage, these URIs must have the form gs://<bucket-name>/<object-name>.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getImportGcsCustomMetadata

Optional. Whether to import custom metadata from Google Cloud Storage.

Only valid when the document source is Google Cloud Storage URI.

Returns
TypeDescription
bool

setImportGcsCustomMetadata

Optional. Whether to import custom metadata from Google Cloud Storage.

Only valid when the document source is Google Cloud Storage URI.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getSmartMessagingPartialUpdate

Optional. When enabled, the reload request is to apply partial update to the smart messaging allowlist.

Returns
TypeDescription
bool

setSmartMessagingPartialUpdate

Optional. When enabled, the reload request is to apply partial update to the smart messaging allowlist.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getSource

Returns
TypeDescription
string

static::build

Parameters
NameDescription
name string

Required. The name of the document to reload. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID> Please see Google\Cloud\Dialogflow\V2\DocumentsClient::documentName() for help formatting this field.

contentUri string

Optional. The path of gcs source file for reloading document content. For now, only gcs uri is supported.

For documents stored in Google Cloud Storage, these URIs must have the form gs://<bucket-name>/<object-name>.

Returns
TypeDescription
Google\Cloud\Dialogflow\V2\ReloadDocumentRequest