REST Resource: matters.exports

संसाधन: एक्सपोर्ट

एक्सपोर्ट.

Vault के संसाधनों के साथ काम करने के लिए, खाते के पास Vault के ज़रूरी खास अधिकार और मामले का ऐक्सेस होना चाहिए. किसी मामले को ऐक्सेस करने के लिए, ज़रूरी है कि खाते ने वह मामला बनाया हो, उसके साथ वह मामला शेयर किया गया हो या उसके पास सभी मामले देखें की सुविधा हो.

JSON के काेड में दिखाना
{
  "id": string,
  "matterId": string,
  "parentExportId": string,
  "name": string,
  "requester": {
    object (UserInfo)
  },
  "query": {
    object (Query)
  },
  "exportOptions": {
    object (ExportOptions)
  },
  "createTime": string,
  "status": enum (ExportStatus),
  "stats": {
    object (ExportStats)
  },

  // Union field export_sink can be only one of the following:
  "cloudStorageSink": {
    object (CloudStorageSink)
  }
  // End of list of possible types for union field export_sink.
}
फ़ील्ड
id

string

सिर्फ़ आउटपुट के लिए. जनरेट किया गया एक्सपोर्ट आईडी.

matterId

string

सिर्फ़ आउटपुट के लिए. मैटर का आईडी.

parentExportId

string

सिर्फ़ आउटपुट के लिए. उस पैरंट एक्सपोर्ट की पहचान करता है जिससे यह चाइल्ड एक्सपोर्ट जनरेट हुआ है. यह सिर्फ़ चाइल्ड एक्सपोर्ट पर सेट होता है.

name

string

एक्सपोर्ट का नाम. नाम में खास वर्णों (~!$'(),;@:/?) का इस्तेमाल न करें. इनकी वजह से, एक्सपोर्ट डाउनलोड नहीं किए जा सकते.

requester

object (UserInfo)

सिर्फ़ आउटपुट के लिए. एक्सपोर्ट का अनुरोध करने वाला व्यक्ति.

query

object (Query)

एक्सपोर्ट बनाने के लिए इस्तेमाल किए गए क्वेरी पैरामीटर.

exportOptions

object (ExportOptions)

एक्सपोर्ट करने के अन्य विकल्प.

createTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. एक्सपोर्ट बनाने का समय.

आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़्ड होता है और इसमें 0, 3, 6 या 9 दशमलव अंक इस्तेमाल किए जाते हैं. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".

status

enum (ExportStatus)

सिर्फ़ आउटपुट के लिए. एक्सपोर्ट की स्थिति.

stats

object (ExportStats)

सिर्फ़ आउटपुट के लिए. एक्सपोर्ट की प्रोग्रेस और साइज़ के बारे में जानकारी.

यूनियन फ़ील्ड export_sink. एक्सपोर्ट सिंक का टाइप. export_sink इनमें से कोई एक हो सकता है:
cloudStorageSink

object (CloudStorageSink)

सिर्फ़ आउटपुट के लिए. Cloud Storage में एक्सपोर्ट की गई फ़ाइलों के लिए सिंक.

UserInfo

उपयोगकर्ता की जानकारी.

JSON के काेड में दिखाना
{
  "email": string,
  "displayName": string
}
फ़ील्ड
email

string

उपयोगकर्ता का ईमेल पता.

displayName

string

उपयोगकर्ता का दिखाया गया नाम.

ExportOptions

एक्सपोर्ट के लिए अन्य विकल्प

JSON के काेड में दिखाना
{
  "region": enum (ExportRegion),

  // Union field corpus_export_options can be only one of the following:
  "mailOptions": {
    object (MailExportOptions)
  },
  "groupsOptions": {
    object (GroupsExportOptions)
  },
  "driveOptions": {
    object (DriveExportOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatExportOptions)
  },
  "voiceOptions": {
    object (VoiceExportOptions)
  },
  "calendarOptions": {
    object (CalendarExportOptions)
  },
  "geminiOptions": {
    object (GeminiExportOptions)
  }
  // End of list of possible types for union field corpus_export_options.
}
फ़ील्ड
region

enum (ExportRegion)

एक्सपोर्ट के लिए अनुरोध किया गया डेटा क्षेत्र.

यूनियन फ़ील्ड corpus_export_options. एक्सपोर्ट के लिए, सेवा के हिसाब से विकल्प. corpus_export_options इनमें से कोई एक हो सकता है:
mailOptions

object (MailExportOptions)

Gmail से डेटा एक्सपोर्ट करने के विकल्प.

groupsOptions

object (GroupsExportOptions)

Groups से डेटा एक्सपोर्ट करने के विकल्प.

driveOptions

object (DriveExportOptions)

Drive से एक्सपोर्ट करने के विकल्प.

hangoutsChatOptions

object (HangoutsChatExportOptions)

Chat से डेटा एक्सपोर्ट करने के विकल्प.

voiceOptions

object (VoiceExportOptions)

वॉइस एक्सपोर्ट के विकल्प.

calendarOptions

object (CalendarExportOptions)

Calendar से डेटा एक्सपोर्ट करने का विकल्प.

geminiOptions

object (GeminiExportOptions)

Gemini से एक्सपोर्ट करने के लिए उपलब्ध विकल्प.

MailExportOptions

Gmail से डेटा एक्सपोर्ट करने के विकल्प.

JSON के काेड में दिखाना
{
  "exportFormat": enum (ExportFormat),
  "showConfidentialModeContent": boolean,
  "useNewExport": boolean,
  "exportLinkedDriveFiles": boolean
}
फ़ील्ड
exportFormat

enum (ExportFormat)

एक्सपोर्ट किए गए मैसेज का फ़ाइल फ़ॉर्मैट.

showConfidentialModeContent

boolean

गोपनीय मोड में मौजूद कॉन्टेंट को एक्सपोर्ट करने के लिए, इस विकल्प को सही है पर सेट करें.

useNewExport

boolean

नए एक्सपोर्ट सिस्टम का इस्तेमाल करने के लिए, इसकी वैल्यू को सही है पर सेट करें.

exportLinkedDriveFiles

boolean

ज़रूरी नहीं. लिंक की गई Drive फ़ाइलों को एक्सपोर्ट करने की सुविधा चालू करने के लिए, इसे सही पर सेट करें.

ExportFormat

मैसेज के लिए एक्सपोर्ट फ़ॉर्मैट

Enums
EXPORT_FORMAT_UNSPECIFIED एक्सपोर्ट का कोई फ़ॉर्मैट नहीं चुना गया है.
MBOX MBOX फ़ॉर्मैट में एक्सपोर्ट करें. यह सुविधा सिर्फ़ Gmail, Groups, Hangouts, और Voice के लिए उपलब्ध है.
PST PST के तौर पर एक्सपोर्ट करें. यह सुविधा सिर्फ़ Gmail, Groups, Hangouts, Voice, और Calendar के लिए उपलब्ध है.
ICS ICS के तौर पर एक्सपोर्ट करें. यह सुविधा सिर्फ़ Calendar के लिए उपलब्ध है.
XML एक्सएमएल फ़ॉर्मैट में एक्सपोर्ट करें. यह सुविधा सिर्फ़ Gemini के लिए उपलब्ध है.

GroupsExportOptions

Groups से डेटा एक्सपोर्ट करने के विकल्प.

JSON के काेड में दिखाना
{
  "exportFormat": enum (ExportFormat)
}
फ़ील्ड
exportFormat

enum (ExportFormat)

एक्सपोर्ट किए गए मैसेज का फ़ाइल फ़ॉर्मैट.

DriveExportOptions

Drive से एक्सपोर्ट करने के विकल्प.

JSON के काेड में दिखाना
{
  "includeAccessInfo": boolean
}
फ़ील्ड
includeAccessInfo

boolean

जिन उपयोगकर्ताओं के पास फ़ाइलों का अप्रत्यक्ष ऐक्सेस है उनके लिए, ऐक्सेस लेवल की जानकारी शामिल करने के लिए, इस विकल्प को सही पर सेट करें.

HangoutsChatExportOptions

Chat से डेटा एक्सपोर्ट करने के विकल्प.

JSON के काेड में दिखाना
{
  "exportFormat": enum (ExportFormat)
}
फ़ील्ड
exportFormat

enum (ExportFormat)

एक्सपोर्ट किए गए मैसेज का फ़ाइल फ़ॉर्मैट.

VoiceExportOptions

वॉइस एक्सपोर्ट के विकल्प.

JSON के काेड में दिखाना
{
  "exportFormat": enum (ExportFormat)
}
फ़ील्ड
exportFormat

enum (ExportFormat)

एक्सपोर्ट किए गए टेक्स्ट मैसेज का फ़ाइल फ़ॉर्मैट.

CalendarExportOptions

Calendar से डेटा एक्सपोर्ट करने के विकल्प.

JSON के काेड में दिखाना
{
  "exportFormat": enum (ExportFormat)
}
फ़ील्ड
exportFormat

enum (ExportFormat)

एक्सपोर्ट किए गए टेक्स्ट मैसेज का फ़ाइल फ़ॉर्मैट.

GeminiExportOptions

Gemini से एक्सपोर्ट करने के विकल्प.

JSON के काेड में दिखाना
{
  "exportFormat": enum (ExportFormat)
}
फ़ील्ड
exportFormat

enum (ExportFormat)

एक्सपोर्ट किए गए मैसेज का फ़ाइल फ़ॉर्मैट.

ExportRegion

एक्सपोर्ट के लिए डेटा क्षेत्र.

Enums
EXPORT_REGION_UNSPECIFIED क्षेत्र की जानकारी नहीं दी गई है. डिफ़ॉल्ट रूप से, ANY पर सेट होती है.
ANY कोई भी क्षेत्र.
US अमेरिका का क्षेत्र.
EUROPE यूरोप क्षेत्र.

ExportStatus

एक्सपोर्ट की स्थिति.

Enums
EXPORT_STATUS_UNSPECIFIED स्टेटस की जानकारी नहीं है.
COMPLETED एक्सपोर्ट की प्रोसेस पूरी हो गई.
FAILED एक्सपोर्ट नहीं हो सका.
IN_PROGRESS डेटा एक्सपोर्ट किया जा रहा है.

ExportStats

एक्सपोर्ट की प्रोग्रेस की जानकारी.

JSON के काेड में दिखाना
{
  "exportedArtifactCount": string,
  "totalArtifactCount": string,
  "sizeInBytes": string
}
फ़ील्ड
exportedArtifactCount

string (int64 format)

एक्सपोर्ट के लिए पहले से प्रोसेस किए गए मैसेज या फ़ाइलों की संख्या.

totalArtifactCount

string (int64 format)

एक्सपोर्ट किए जाने वाले मैसेज या फ़ाइलों की संख्या.

sizeInBytes

string (int64 format)

एक्सपोर्ट का साइज़, बाइट में.

CloudStorageSink

Cloud Storage फ़ाइलों के लिए एक्सपोर्ट सिंक.

JSON के काेड में दिखाना
{
  "files": [
    {
      object (CloudStorageFile)
    }
  ]
}
फ़ील्ड
files[]

object (CloudStorageFile)

सिर्फ़ आउटपुट के लिए. Cloud Storage में एक्सपोर्ट की गई फ़ाइलें.

CloudStorageFile

Cloud Storage में एक्सपोर्ट की गई फ़ाइल

JSON के काेड में दिखाना
{
  "bucketName": string,
  "objectName": string,
  "size": string,
  "md5Hash": string
}
फ़ील्ड
bucketName

string

एक्सपोर्ट की जाने वाली फ़ाइल के लिए, Cloud Storage बकेट का नाम. इस वैल्यू का इस्तेमाल, Cloud Storage के JSON API या XML API में किया जा सकता है. हालांकि, इसका इस्तेमाल बकेट के कॉन्टेंट की सूची बनाने के लिए नहीं किया जा सकता. इसके बजाय, ऑब्जेक्ट के नाम के हिसाब से अलग-अलग एक्सपोर्ट फ़ाइलें पाएं.

objectName

string

एक्सपोर्ट की गई फ़ाइल के लिए, Cloud Storage ऑब्जेक्ट का नाम. इस वैल्यू का इस्तेमाल, Cloud Storage के JSON API या XML API में किया जा सकता है.

size

string (int64 format)

एक्सपोर्ट की गई फ़ाइल का साइज़.

md5Hash

string

फ़ाइल का md5 हैश.

तरीके

create

एक्सपोर्ट बनाता है.

delete

किसी एक्सपोर्ट को मिटाता है.

get

एक्सपोर्ट मिलता है.

list

इसमें, बताए गए मामले में एक्सपोर्ट की जानकारी दी जाती है.