Ressource: Job
Die Beschreibung des Jobs für Speicher-Batchvorgänge
| JSON-Darstellung |
|---|
{ "name": string, "description": string, "loggingConfig": { object ( |
| Felder | |
|---|---|
name |
Kennung. Der Ressourcenname des Jobs. Format: Beispiel:
|
description |
Optional. Eine vom Nutzer angegebene Beschreibung des Jobs. Maximale Länge: 1.024 Byte bei Unicode-Codierung. |
loggingConfig |
Optional. Logging-Konfiguration. |
createTime |
Nur Ausgabe. Der Zeitpunkt, zu dem der Job erstellt wurde. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
scheduleTime |
Nur Ausgabe. Der Zeitpunkt, zu dem der Job geplant wurde. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
completeTime |
Nur Ausgabe. Die Zeit, zu der der Job abgeschlossen wurde. Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: |
counters |
Nur Ausgabe. Informationen zum Fortschritt des Jobs. |
errorSummaries[] |
Nur Ausgabe. Fasst Fehler zusammen, die mit Beispiel-Fehlerlogeinträgen aufgetreten sind. |
state |
Nur Ausgabe. Status des Jobs. |
Union-Feld source. Gibt die zu transformierenden Objekte an. Für source ist nur einer der folgenden Werte zulässig: |
|
bucketList |
Gibt eine Liste von Buckets und ihren Objekten an, die transformiert werden sollen. |
Union-Feld transformation. Vorgang, der für die Objekte ausgeführt werden soll. Für transformation ist nur einer der folgenden Werte zulässig: |
|
putObjectHold |
Ändert den Hold-Status des Objekts. |
deleteObject |
Objekte löschen. |
putMetadata |
Aktualisiert Objektmetadaten. Ermöglicht das Aktualisieren von Metadaten mit festen Schlüsseln und benutzerdefinierten Metadaten. Beispiel: |
rewriteObject |
Schreibt das Objekt neu und aktualisiert Metadaten wie den KMS-Schlüssel. |
BucketList
Beschreibt die Liste der Buckets und ihrer Objekte, die transformiert werden sollen.
| JSON-Darstellung |
|---|
{
"buckets": [
{
object ( |
| Felder | |
|---|---|
buckets[] |
Erforderlich. Liste der Buckets und ihrer zu transformierenden Objekte. Sie können nur einen Bucket pro Job angeben. Wenn mehrere Buckets angegeben werden, tritt ein Fehler auf. |
Bucket
Beschreibt die Konfiguration eines einzelnen Buckets und seiner zu transformierenden Objekte.
| JSON-Darstellung |
|---|
{ "bucket": string, // Union field |
| Felder | |
|---|---|
bucket |
Erforderlich. Bucket-Name für die zu transformierenden Objekte. |
Union-Feld object_configuration. Gibt die zu transformierenden Objekte an. Für object_configuration ist nur einer der folgenden Werte zulässig: |
|
prefixList |
Gibt Objekte an, die einem Präfixsatz entsprechen. |
manifest |
Gibt Objekte in einer Manifestdatei an. |
PrefixList
Beschreibt die Präfixe der zu transformierenden Objekte.
| JSON-Darstellung |
|---|
{ "includedObjectPrefixes": [ string ] } |
| Felder | |
|---|---|
includedObjectPrefixes[] |
Optional. Geben Sie mindestens ein Objektpräfix an. Beispiel:
|
Manifest
Beschreibt die Liste der zu transformierenden Objekte.
| JSON-Darstellung |
|---|
{ "manifestLocation": string } |
| Felder | |
|---|---|
manifestLocation |
Erforderlich. Geben Sie den Speicherort der Manifestdatei an, z. B. Die Datei muss eine Kopfzeile im folgenden Format enthalten: Hinweis: In der Manifestdatei dürfen nur Objekte im Bucket angegeben werden, der für den Job bereitgestellt wurde. Zeilen, die auf Objekte in anderen Buckets verweisen, werden ignoriert. |
PutObjectHold
Beschreibt Optionen zum Aktualisieren von Objekt-Holds.
| JSON-Darstellung |
|---|
{ "temporaryHold": enum ( |
| Felder | |
|---|---|
temporaryHold |
Erforderlich. Aktualisiert den temporären Hold-Status des Objekts. Wenn ein temporärer Hold für ein Objekt festgelegt ist, kann das Objekt nicht gelöscht oder ersetzt werden. |
eventBasedHold |
Erforderlich. Aktualisiert den Status von ereignisbasierten Holds für Objekte. Wenn ein ereignisbasierter Hold für ein Objekt festgelegt ist, kann das Objekt nicht gelöscht oder ersetzt werden. Setzt die Zeit des Objekts im Bucket in Bezug auf die Aufbewahrungsdauer zurück. |
HoldStatus
Beschreibt den Status des Holds.
| Enums | |
|---|---|
HOLD_STATUS_UNSPECIFIED |
Standardwert. Der Hold-Status des Objekts wird nicht geändert. |
SET |
Platziert den Hold. |
UNSET |
Hebt den Hold auf. |
DeleteObject
Beschreibt Optionen zum Löschen eines Objekts.
| JSON-Darstellung |
|---|
{ "permanentObjectDeletionEnabled": boolean } |
| Felder | |
|---|---|
permanentObjectDeletionEnabled |
Erforderlich. Steuert das Löschverhalten, wenn die Versionsverwaltung für den Bucket des Objekts aktiviert ist. Bei „true“ werden sowohl Live- als auch nicht aktuelle Objekte endgültig gelöscht. Andernfalls werden Live-Objekte in Buckets mit aktivierter Versionsverwaltung nicht aktuell und Objekte, die bereits nicht aktuell waren, werden übersprungen. Diese Einstellung hat keine Auswirkungen auf die Funktion zum vorläufigen Löschen. Alle von diesem Dienst gelöschten Objekte können während der Aufbewahrungsdauer für das vorläufige Löschen wiederhergestellt werden, sofern diese Funktion aktiviert ist. Wenn diese Option aktiviert ist und im Manifest keine Generation für ein Objekt angegeben ist, wird ein |
PutMetadata
Beschreibt Optionen zum Aktualisieren von Objektmetadaten.
| JSON-Darstellung |
|---|
{
"customMetadata": {
string: string,
...
},
"contentDisposition": string,
"contentEncoding": string,
"contentLanguage": string,
"contentType": string,
"cacheControl": string,
"customTime": string
"objectRetention": {
object ( |
| Felder | |
|---|---|
customMetadata |
Optional. Aktualisiert die benutzerdefinierten Metadaten des Objekts. Mit diesem Vorgang werden einzelne benutzerdefinierte Metadaten-Schlüssel/Wert-Paare hinzugefügt oder festgelegt. Bei Schlüsseln, die mit leeren Werten angegeben werden, werden die Werte gelöscht. Vorhandene benutzerdefinierte Metadatenschlüssel, die nicht in der Anfrage enthalten sind, bleiben unverändert. Weitere Informationen finden Sie unter Custom-Metadata. Ein Objekt, das eine Liste von |
contentDisposition |
Optional. Aktualisiert die festen |
contentEncoding |
Optional. Aktualisiert die festen |
contentLanguage |
Optional. Aktualisiert die festen Metadaten für die Inhaltssprache der Objekte. Für Metadatenwerte müssen ISO 639-1-Sprachcodes verwendet werden. Metadatenwerte dürfen maximal 100 Zeichen lang sein. Nicht festgelegte Werte in der Anfrage werden ignoriert. Wenn Sie die Metadaten löschen möchten, legen Sie einen leeren Wert fest. Weitere Informationen finden Sie unter Content-Language. |
contentType |
Optional. Aktualisiert die festen |
cacheControl |
Optional. Aktualisiert die festen |
customTime |
Optional. Aktualisiert die festen Metadaten für die benutzerdefinierte Zeit des Objekts. Nicht festgelegte Werte in der Anfrage werden ignoriert. Wenn Sie die Metadaten löschen möchten, legen Sie einen leeren Wert fest. Weitere Informationen finden Sie unter Custom-Time. |
objectRetention |
Optional. Aktualsiert die Aufbewahrungskonfiguration eines Objekts. Nicht festgelegte Werte werden ignoriert. Damit die Aufbewahrung eines Objekts gelöscht wird, muss sich der |
ObjectRetention
Beschreibt die Konfiguration für die Objektaufbewahrung.
| JSON-Darstellung |
|---|
{
"retainUntilTime": string,
"retentionMode": enum ( |
| Felder | |
|---|---|
retainUntilTime |
Erforderlich. Das Ablaufdatum der Aufbewahrung des Objekts, während dessen das Objekt vor dem Löschen oder Überschreiben geschützt ist. Die Zeit muss im RFC 3339-Format angegeben werden, z. B. |
retentionMode |
Erforderlich. Der Aufbewahrungsmodus. |
RetentionMode
Der Aufbewahrungsmodus.
| Enums | |
|---|---|
RETENTION_MODE_UNSPECIFIED |
Der Aufbewahrungsmodus ist nicht angegeben. |
LOCKED |
Wenn der Aufbewahrungsmodus LOCKED ist, kann retainUntilTime nicht entfernt oder verkürzt werden. |
UNLOCKED |
Wenn der Aufbewahrungsmodus UNLOCKED ist, kann retainUntilTime entfernt oder geändert werden. |
RewriteObject
Beschreibt Optionen zum Umschreiben von Objekten.
| JSON-Darstellung |
|---|
{ "kmsKey": string } |
| Felder | |
|---|---|
kmsKey |
Erforderlich. Ressourcenname des Cloud KMS-Schlüssels, der zum Verschlüsseln des Objekts verwendet wird. Der Cloud KMS-Schlüssel muss sich am selben Ort wie das Objekt befinden. Weitere Informationen finden Sie unter Objekte mit einem Cloud KMS-Schlüssel verschlüsseln. Format: Beispiel: |
LoggingConfig
Gibt das Cloud Logging-Verhalten an.
| JSON-Darstellung |
|---|
{ "logActions": [ enum ( |
| Felder | |
|---|---|
logActions[] |
Erforderlich. Gibt die Aktionen an, die protokolliert werden sollen. |
logActionStates[] |
Erforderlich. Status, in denen Aktionen protokolliert werden. Wenn das Feld leer ist, werden keine Logs generiert. |
LoggableAction
Protokollierbare Aktionstypen.
| Enums | |
|---|---|
LOGGABLE_ACTION_UNSPECIFIED |
Ungültiger Wert, um einen Standardwert zu vermeiden. |
TRANSFORM |
Die entsprechende Transformationsaktion in diesem Job. |
LoggableActionState
Filter für protokollierbare Aktionsstatus.
| Enums | |
|---|---|
LOGGABLE_ACTION_STATE_UNSPECIFIED |
Ungültiger Wert, um einen Standardwert zu vermeiden. |
SUCCEEDED |
LoggableAction wurde erfolgreich abgeschlossen. SUCCEEDED-Aktionen werden als [INFO][google.logging.type.LogSeverity.INFO] protokolliert. |
FAILED |
LoggableAction wurde mit einem Fehlerstatus beendet. FAILED-Aktionen werden als [ERROR][google.logging.type.LogSeverity.ERROR] protokolliert. |
Zähler
Beschreibt Details zum Fortschritt des Jobs.
| JSON-Darstellung |
|---|
{ "totalObjectCount": string, "succeededObjectCount": string, "failedObjectCount": string } |
| Felder | |
|---|---|
totalObjectCount |
Nur Ausgabe. Anzahl der gelisteten Objekte. |
succeededObjectCount |
Nur Ausgabe. Anzahl der abgeschlossenen Objekte. |
failedObjectCount |
Nur Ausgabe. Anzahl der fehlgeschlagenen Objekte. |
ErrorSummary
Eine Zusammenfassung der Fehler nach Fehlercode sowie eine Anzahl und Beispiel-Fehlerlogeinträge.
| JSON-Darstellung |
|---|
{ "errorCode": enum ( |
| Felder | |
|---|---|
errorCode |
Erforderlich. Der kanonische Fehlercode. |
errorCount |
Erforderlich. Anzahl der Fehler, die pro |
errorLogEntries[] |
Erforderlich. Beispiel für Fehlerlogs. |
Code
Definiert Fehlercodes, die für die Verarbeitung von gRPC API-Antworten verwendet werden.
Wenn mehrere Fehlercodes zutreffen, geben Sie den spezifischsten Fehlercode zurück. Beispiel: OUT_OF_RANGE sollte gegenüber FAILED_PRECONDITION bevorzugt werden, wenn beide Codes zutreffen. Entsprechend ist NOT_FOUND oder ALREADY_EXISTS gegenüber FAILED_PRECONDITION vorzuziehen.
| Enums | |
|---|---|
OK |
Wird zurückgegeben, wenn der Vorgang erfolgreich abgeschlossen wurde. HTTP Mapping: 200 OK |
CANCELLED |
Der Vorgang wurde abgebrochen, üblicherweise vom Aufrufer. HTTP Mapping: 499 Client Closed Request |
UNKNOWN |
Unbekannter Fehler. Dieser Fehler wird z. B. angezeigt, wenn ein von einem anderen Adressbereich erhaltener HTTP Mapping: 500 Internal Server Error |
INVALID_ARGUMENT |
Der Client hat ein ungültiges Argument angegeben. Dieser Wert ist nicht identisch mit HTTP Mapping: 400 Bad Request |
DEADLINE_EXCEEDED |
Die Frist ist abgelaufen, bevor der Vorgang abgeschlossen werden konnte. Bei Vorgängen, die den Systemstatus verändern, kann dieser Fehler angezeigt werden, auch wenn der Vorgang erfolgreich abgeschlossen wurde. Zum Beispiel könnte eine erfolgreiche Antwort von einem Server so lange verzögert worden sein, dass die Frist abgelaufen ist. HTTP Mapping: 504 Gateway Timeout |
NOT_FOUND |
Eine angeforderte Entität (z. B. Datei oder Verzeichnis) wurde nicht gefunden. Hinweis für Serverentwickler: Wenn eine Anfrage, z. B. eine schrittweise Einführung von Funktionen oder eine undokumentierte Zulassungsliste, für eine gesamte Nutzerklasse abgelehnt wird, kann HTTP Mapping: 404 Not Found |
ALREADY_EXISTS |
Die Entität, die ein Client erstellen wollte (z. B. eine Datei oder ein Verzeichnis), ist bereits vorhanden. HTTP Mapping: 409 Conflict |
PERMISSION_DENIED |
Der Aufrufer hat keine Berechtigung zur Ausführung des angegebenen Vorgangs. HTTP Mapping: 403 Forbidden |
UNAUTHENTICATED |
Die Anfrage enthält keine gültigen Authentifizierungsanmeldedaten für diesen Vorgang. HTTP Mapping: 401 Unauthorized |
RESOURCE_EXHAUSTED |
Eine Ressource, z. B. ein nutzerbezogenes Kontingent, ist erschöpft oder der Speicherplatz für das gesamte Dateisystem ist ausgegangen. HTTP Mapping: 429 Too Many Requests |
FAILED_PRECONDITION |
Der Vorgang wurde abgelehnt, weil der Systemzustand nicht für die Ausführung des Vorgangs geeignet ist. Beispielsweise ist das zu löschende Verzeichnis nicht leer, ein rmdir-Vorgang wird auf eine Ressource angewendet, die kein Verzeichnis ist, usw. Dienstimplementierungen können anhand der folgenden Richtlinien zwischen
HTTP Mapping: 400 Bad Request |
ABORTED |
Der Vorgang wurde abgebrochen, in der Regel aufgrund eines Parallelitätsproblems wie einer fehlgeschlagenen Sequencer-Überprüfung oder einer abgebrochenen Transaktion. Siehe obige Richtlinien zum Abwägen zwischen HTTP Mapping: 409 Conflict |
OUT_OF_RANGE |
Beim Vorgang wurde versucht, den gültigen Bereich zu überschreiten. Beispiel: Such- oder Lesevorgang über das Dateiende hinaus. Im Gegensatz zu Es gibt einige Überschneidungen zwischen HTTP Mapping: 400 Bad Request |
UNIMPLEMENTED |
Dieser Vorgang ist nicht implementiert oder wird bei diesem Dienst nicht unterstützt bzw. ist bei diesem Dienst nicht aktiviert. HTTP Mapping: 501 Not Implemented |
INTERNAL |
Interne Fehler. Das bedeutet, dass einige Invarianten, die vom zugrunde liegenden System erwartet werden, nicht erfüllt wurden. Dieser Fehlercode ist für schwerwiegende Fehler reserviert. HTTP Mapping: 500 Internal Server Error |
UNAVAILABLE |
Der Dienst ist derzeit nicht verfügbar. Dies ist höchstwahrscheinlich ein vorübergehender Zustand, der durch Wiederholen mit einem Backoff korrigiert werden kann. Es ist nicht immer sicher, nicht idempotente Vorgänge zu wiederholen. Siehe obige Richtlinien zum Abwägen zwischen HTTP Mapping: 503 Service Unavailable |
DATA_LOSS |
Dauerhafter Datenverlust oder Datenkorruption. HTTP Mapping: 500 Internal Server Error |
ErrorLogEntry
Ein Eintrag, der einen aufgetretenen Fehler beschreibt.
| JSON-Darstellung |
|---|
{ "objectUri": string, "errorDetails": [ string ] } |
| Felder | |
|---|---|
objectUri |
Erforderlich. Nur Ausgabe. Objekt-URL. Beispiel: |
errorDetails[] |
Optional. Nur Ausgabe. Pro Fehlercode werden maximal fünf Fehlerlogeinträge für jeden Job aufgezeichnet. |
Status
Beschreibt den Status eines Jobs.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Standardwert. Dieser Wert wird nicht verwendet. |
RUNNING |
In Bearbeitung. |
SUCCEEDED |
Erfolgreich abgeschlossen. |
CANCELED |
Vom Nutzer abgebrochen. |
FAILED |
Aufgrund eines nicht behebbaren Fehlers beendet. |
Methoden |
|
|---|---|
|
Bricht einen Batchjob in einem angegebenen Projekt für einen angegebenen Standort ab. |
|
Erstellt einen Batchjob in einem bestimmten Projekt für einen bestimmten Standort. |
|
Löscht einen Batchjob in einem bestimmten Projekt für einen bestimmten Standort. |
|
Ruft einen Batchjob in einem bestimmten Projekt für einen bestimmten Standort ab. |
|
Listet alle Batchjobs in einem bestimmten Projekt für einen bestimmten Standort auf. |