Ressource: Job
Die Jobbeschreibung 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 der Aufgabe. Maximale Länge: 1.024 Byte bei Unicode-Codierung. |
loggingConfig |
Optional. Logging-Konfiguration. |
createTime |
Nur Ausgabe. Die Uhrzeit, zu der der Job erstellt wurde. Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: |
scheduleTime |
Nur Ausgabe. Der Zeitpunkt, zu dem der Job geplant wurde. Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: |
completeTime |
Nur Ausgabe. Der Zeitpunkt, zu dem der Job abgeschlossen wurde. Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: |
counters |
Nur Ausgabe. Informationen zum Fortschritt des Jobs. |
errorSummaries[] |
Nur Ausgabe. Hier werden Fehler zusammengefasst, die in Beispielen für Fehlerprotokolleinträge 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 deren zu transformierenden Objekten an. |
Union-Feld transformation . Vorgang, der auf den Objekten ausgeführt werden soll. Für transformation ist nur einer der folgenden Werte zulässig: |
|
putObjectHold |
Ändert den Status des Objekt-Holds. |
deleteObject |
Objekte löschen |
putMetadata |
Aktualisiert die Objektmetadaten. Ermöglicht das Aktualisieren von Metadaten mit festem Schlüssel und benutzerdefinierten Metadaten. Beispiel: |
rewriteObject |
Das Objekt wird neu geschrieben und Metadaten wie der KMS-Schlüssel werden aktualisiert. |
BucketList
Liste der Buckets und ihrer zu transformierenden Objekte.
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 Bucket 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 mit einem festgelegten Präfix übereinstimmen. |
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
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 für den Job bereitgestellten Bucket angegeben werden. Zeilen, die auf Objekte in anderen Buckets verweisen, werden ignoriert. |
PutObjectHold
Hier werden die Optionen zum Aktualisieren der Objektsperre beschrieben.
JSON-Darstellung |
---|
{ "temporaryHold": enum ( |
Felder | |
---|---|
temporaryHold |
Erforderlich. Aktualisiert den temporären Hold-Status des Objekts. Wenn für ein Objekt ein vorübergehender Hold festgelegt ist, kann es nicht gelöscht oder ersetzt werden. |
eventBasedHold |
Erforderlich. Aktualisiert den Status der ereignisbasierten Holds für Objekte. Wenn ein ereignisbasierter Hold für ein Objekt festgelegt ist, kann es nicht gelöscht oder ersetzt werden. Die Zeit des Objekts im Bucket wird auf den Beginn der Aufbewahrungsdauer zurückgesetzt. |
HoldStatus
Beschreibt den Status der Vorautorisierung.
Enums | |
---|---|
HOLD_STATUS_UNSPECIFIED |
Standardwert. Der Status der Objektsperre ändert sich nicht. |
SET |
Legt die Vorautorisierung fest. |
UNSET |
Die Vorautorisierung wird aufgehoben. |
DeleteObject
Hier werden die Optionen zum Löschen eines Objekts beschrieben.
JSON-Darstellung |
---|
{ "permanentObjectDeletionEnabled": boolean } |
Felder | |
---|---|
permanentObjectDeletionEnabled |
Erforderlich. Steuert das Löschverhalten, wenn die Versionierung für den Bucket des Objekts aktiviert ist. Wenn diese Option aktiviert ist, werden sowohl Live- als auch nicht aktuelle Objekte endgültig gelöscht. Andernfalls werden Liveobjekte in versionierten Buckets nicht aktuell und Objekte, die bereits nicht aktuell waren, werden übersprungen. Diese Einstellung hat keine Auswirkungen auf die Funktion „Weniger sichtbar machen“. Alle Objekte, die von diesem Dienst gelöscht wurden, können während der Aufbewahrungsdauer für das vorläufige Löschen wiederhergestellt werden, sofern diese aktiviert ist. Wenn diese Funktion 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 } |
Felder | |
---|---|
customMetadata |
Optional. Die benutzerdefinierten Metadaten des Objekts werden aktualisiert. Mit diesem Vorgang werden einzelne benutzerdefinierte Metadaten-Schlüssel/Wert-Paare hinzugefügt oder festgelegt. Die Werte von Schlüsseln, die mit leeren Werten angegeben wurden, werden gelöscht. Vorhandene benutzerdefinierte Metadatenschlüssel, die nicht in der Anfrage enthalten sind, bleiben unverändert. Weitere Informationen finden Sie unter Benutzerdefinierte Metadaten. Ein Objekt, das eine Liste von |
contentDisposition |
Optional. Aktualisiert die |
contentEncoding |
Optional. Aktualisiert die |
contentLanguage |
Optional. Aktualisiert die Metadaten für die Sprache des fixen Inhalts des Objekts. Für Metadatenwerte müssen ISO 639-1-Sprachcodes verwendet werden. Die maximale Länge von Metadatenwerten beträgt 100 Zeichen. Nicht festgelegte Werte in der Anfrage werden ignoriert. Wenn Sie die Metadaten löschen möchten, geben Sie einen leeren Wert an. Weitere Informationen finden Sie unter Content-Language. |
contentType |
Optional. Aktualisiert die |
cacheControl |
Optional. Aktualisiert die |
customTime |
Optional. Die Metadaten für die feste benutzerdefinierte Zeit des Objekts werden aktualisiert. Nicht festgelegte Werte in der Anfrage werden ignoriert. Wenn Sie die Metadaten löschen möchten, geben Sie einen leeren Wert an. Weitere Informationen finden Sie unter Custom-Time. |
RewriteObject
Beschreibt Optionen für das 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 dem Aktionen protokolliert werden. Wenn das Feld leer ist, werden keine Protokolle generiert. |
LoggableAction
Zu protokollierende 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 in einem Fehlerstatus beendet. FAILED -Aktionen werden als [ERROR][google.logging.type.LogSeverity.ERROR] protokolliert. |
Zähler
Hier finden Sie Details zum Fortschritt des Jobs.
JSON-Darstellung |
---|
{ "totalObjectCount": string, "succeededObjectCount": string, "failedObjectCount": string } |
Felder | |
---|---|
totalObjectCount |
Nur Ausgabe. Anzahl der aufgeführten Objekte. |
succeededObjectCount |
Nur Ausgabe. Anzahl der abgeschlossenen Objekte. |
failedObjectCount |
Nur Ausgabe. Anzahl der fehlgeschlagenen Objekte. |
ErrorSummary
Eine Zusammenfassung der Fehler nach Fehlercode sowie eine Zählung und Beispieleinträge aus dem Fehlerprotokoll.
JSON-Darstellung |
---|
{ "errorCode": enum ( |
Felder | |
---|---|
errorCode |
Erforderlich. Der kanonische Fehlercode. |
errorCount |
Erforderlich. Anzahl der Fehler pro |
errorLogEntries[] |
Erforderlich. Beispielfehlerprotokolle |
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 beispielsweise ausgegeben, wenn ein 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 und Job werden maximal fünf Fehlerprotokolleinträge erfasst. |
Bundesland
Beschreibt den Status eines Jobs.
Enums | |
---|---|
STATE_UNSPECIFIED |
Standardwert Dieser Wert wird nicht verwendet. |
RUNNING |
Läuft. |
SUCCEEDED |
Abgeschlossen. |
CANCELED |
Vom Nutzer abgebrochen. |
FAILED |
Aufgrund eines nicht wiederherstellbaren Fehlers beendet. |
Methoden |
|
---|---|
|
Bricht einen Batchjob in einem bestimmten Projekt für einen bestimmten 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. |