Package com.google.cloud.dialogflow.cx.v3beta1

Interface ExportPlaybookRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ExportPlaybookRequest, ExportPlaybookRequest.Builder
@Generated public interface ExportPlaybookRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    ExportPlaybookRequest.DataFormat
    getDataFormat()
    Optional.
    int
    getDataFormatValue()
    Optional.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    String
    getPlaybookUri()
    Optional.
    com.google.protobuf.ByteString
    getPlaybookUriBytes()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      String getName()
       Required. The name of the playbook to export.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. The name of the playbook to export.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for name.

    • getPlaybookUri

      String getPlaybookUri()
       Optional. The [Google Cloud
 Storage](https://cloud.google.com/storage/docs/) URI to export the playbook
 to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If
 left unspecified, the serialized playbook is returned inline.

 Dialogflow performs a write operation for the Cloud Storage object
 on the caller's behalf, so your request authentication must
 have write permissions for the object. For more information, see
 [Dialogflow access
 control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      string playbook_uri = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The playbookUri.

    • getPlaybookUriBytes

      com.google.protobuf.ByteString getPlaybookUriBytes()
       Optional. The [Google Cloud
 Storage](https://cloud.google.com/storage/docs/) URI to export the playbook
 to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If
 left unspecified, the serialized playbook is returned inline.

 Dialogflow performs a write operation for the Cloud Storage object
 on the caller's behalf, so your request authentication must
 have write permissions for the object. For more information, see
 [Dialogflow access
 control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
      string playbook_uri = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for playbookUri.

    • getDataFormatValue

      int getDataFormatValue()
       Optional. The data format of the exported agent. If not specified, `BLOB`
 is assumed.
      .google.cloud.dialogflow.cx.v3beta1.ExportPlaybookRequest.DataFormat data_format = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for dataFormat.

    • getDataFormat

      ExportPlaybookRequest.DataFormat getDataFormat()
       Optional. The data format of the exported agent. If not specified, `BLOB`
 is assumed.
      .google.cloud.dialogflow.cx.v3beta1.ExportPlaybookRequest.DataFormat data_format = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The dataFormat.