Package google.cloud.dataproc.v1

Index

BatchController

Der BatchController bietet Methoden zum Verwalten von Batcharbeitslasten.

CreateBatch

rpc CreateBatch(CreateBatchRequest) returns (Operation)

Erstellt eine Batcharbeitslast, die asynchron ausgeführt wird.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
DeleteBatch

rpc DeleteBatch(DeleteBatchRequest) returns (Empty)

Löscht die Batch-Arbeitslastressource. Wenn sich der Batch nicht in einem CANCELLED-, SUCCEEDED- oder FAILED-State befindet, schlägt der Löschvorgang fehl und die Antwort gibt FAILED_PRECONDITION zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
GetBatch

rpc GetBatch(GetBatchRequest) returns (Batch)

Ruft die Ressourcendarstellung der Batcharbeitslast ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
ListBatches

rpc ListBatches(ListBatchesRequest) returns (ListBatchesResponse)

Listet Batcharbeitslasten auf.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

SessionController

Die SessionController bietet Methoden zum Verwalten interaktiver Sitzungen.

CreateSession

rpc CreateSession(CreateSessionRequest) returns (Operation)

Interaktive Sitzungen asynchron erstellen

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
DeleteSession

rpc DeleteSession(DeleteSessionRequest) returns (Operation)

Löscht die Ressource für die interaktive Sitzung. Wenn sich die Sitzung nicht im Endzustand befindet, wird sie beendet und dann gelöscht.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
GetSession

rpc GetSession(GetSessionRequest) returns (Session)

Ruft die Ressourcendarstellung für eine interaktive Sitzung ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
ListSessions

rpc ListSessions(ListSessionsRequest) returns (ListSessionsResponse)

Hier werden interaktive Sitzungen aufgelistet.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
TerminateSession

rpc TerminateSession(TerminateSessionRequest) returns (Operation)

Beendet die interaktive Sitzung.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

SessionTemplateController

Der SessionTemplateController bietet Methoden zum Verwalten von Sitzungsvorlagen.

CreateSessionTemplate

rpc CreateSessionTemplate(CreateSessionTemplateRequest) returns (SessionTemplate)

Sitzungsvorlage synchron erstellen

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
DeleteSessionTemplate

rpc DeleteSessionTemplate(DeleteSessionTemplateRequest) returns (Empty)

Löscht eine Sitzungsvorlage.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
GetSessionTemplate

rpc GetSessionTemplate(GetSessionTemplateRequest) returns (SessionTemplate)

Ruft die Ressourcendarstellung für eine Sitzungsvorlage ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
ListSessionTemplates

rpc ListSessionTemplates(ListSessionTemplatesRequest) returns (ListSessionTemplatesResponse)

Listet Sitzungsvorlagen auf.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
UpdateSessionTemplate

rpc UpdateSessionTemplate(UpdateSessionTemplateRequest) returns (SessionTemplate)

Aktualisiert die Sitzungsvorlage synchron.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

AnalyzeOperationMetadata

Metadaten, die den Analysevorgang beschreiben.

Felder
analyzed_workload_name

string

Nur Ausgabe. Name der analysierten Arbeitslast.
analyzed_workload_type

WorkloadType

Nur Ausgabe. Art der zu analysierenden Arbeitslast.
analyzed_workload_uuid

string

Nur Ausgabe. Die eindeutige Kennung der Arbeitslast, die in der Regel von der Kontrollebene generiert wird. Beispiel: Batch-UUID.
create_time

Timestamp

Nur Ausgabe. Die Uhrzeit, zu der der Vorgang erstellt wurde.
done_time

Timestamp

Nur Ausgabe. Der Zeitpunkt, zu dem der Vorgang abgeschlossen wurde.
description

string

Nur Ausgabe. Kurze Beschreibung des Vorgangs.
labels

map<string, string>

Nur Ausgabe. Mit dem Vorgang verknüpfte Labels.
warnings[]

string

Nur Ausgabe. Warnungen, die während der Ausführung des Vorgangs aufgetreten sind.

WorkloadType

Arbeitslasttyp

Enums
WORKLOAD_TYPE_UNSPECIFIED Nicht definierte Option
BATCH Serverloser Batchjob

AutotuningConfig

Konfiguration der automatischen Optimierung der Arbeitslast

Felder
scenarios[]

Scenario

Optional. Szenarien, auf die die Optimierungen angewendet werden.

Szenario

Das Szenario stellt ein bestimmtes Ziel dar, das durch die automatische Optimierung durch Ändern der Arbeitslasten erreicht werden soll.

Enums
SCENARIO_UNSPECIFIED Standardwert.
SCALING Empfehlungen zur Skalierung, z. B. initialExecutors.
BROADCAST_HASH_JOIN Es wurden Hinweise zu möglichen Übertragungen von Verwandtschaftsbeziehungen hinzugefügt.
MEMORY Speicherverwaltung für Arbeitslasten

Batch

Eine Darstellung einer Batcharbeitslast im Dienst.

Felder
name

string

Nur Ausgabe. Der Ressourcenname des Batches.
uuid

string

Nur Ausgabe. Eine Batch-UUID (Unique Universal Identifier). Dieser Wert wird vom Dienst generiert, wenn der Batch erstellt wird.
create_time

Timestamp

Nur Ausgabe. Die Uhrzeit, zu der der Batch erstellt wurde.
runtime_info

RuntimeInfo

Nur Ausgabe. Laufzeitinformationen zur Batchausführung.
state

State

Nur Ausgabe. Der Status des Batches.
state_message

string

Nur Ausgabe. Details zum Batchstatus, z. B. eine Fehlerbeschreibung, wenn der Status FAILED ist.
state_time

Timestamp

Nur Ausgabe. Der Zeitpunkt, zu dem der Batch den aktuellen Status erreicht hat.
creator

string

Nur Ausgabe. Die E-Mail-Adresse des Nutzers, der den Batch erstellt hat.
labels

map<string, string>

Optional. Die Labels, die mit diesem Batch verknüpft werden sollen. Labelschlüssel müssen zwischen 1 und 63 Zeichen lang sein und RFC 1035 entsprechen. Labelwerte können leer sein. Wenn sie vorhanden sind, müssen sie zwischen 1 und 63 Zeichen lang sein und RFC 1035 entsprechen. Einem Batch können maximal 32 Labels zugeordnet werden.
runtime_config

RuntimeConfig

Optional. Laufzeitkonfiguration für die Batchausführung.
environment_config

EnvironmentConfig

Optional. Umgebungskonfiguration für die Batchausführung.
operation

string

Nur Ausgabe. Der Ressourcenname des Vorgangs, der mit diesem Batch verknüpft ist.
state_history[]

StateHistory

Nur Ausgabe. Informationen zum bisherigen Status des Batches.
Union-Feld batch_config. Der anwendungs-/frameworkspezifische Teil der Batchkonfiguration. Für batch_config ist nur einer der folgenden Werte zulässig:
pyspark_batch

PySparkBatch

Optional. PySpark-Batchkonfiguration
spark_batch

SparkBatch

Optional. Spark-Batchkonfiguration
spark_r_batch

SparkRBatch

Optional. SparkR-Batchkonfiguration
spark_sql_batch

SparkSqlBatch

Optional. SparkSql-Batchkonfiguration

Bundesland

Der Batchstatus.

Enums
STATE_UNSPECIFIED Der Batch-Status ist unbekannt.
PENDING Der Batch wird vor der Ausführung erstellt.
RUNNING Der Batch wird ausgeführt.
CANCELLING Der Batch wird abgebrochen.
CANCELLED Die Batch-Kündigung war erfolgreich.
SUCCEEDED Die Batch-Datei wurde erfolgreich abgeschlossen.
FAILED Der Batch wird aufgrund eines Fehlers nicht mehr ausgeführt.

StateHistory

Informationen zum bisherigen Status.

Felder
state

State

Nur Ausgabe. Der Status des Batches zu diesem Zeitpunkt.
state_message

string

Nur Ausgabe. Details zum Status zu diesem Zeitpunkt.
state_start_time

Timestamp

Nur Ausgabe. Der Zeitpunkt, zu dem der Batch in den Status „Vergangen“ gewechselt ist.

BatchOperationMetadata

Metadaten, die den Batchvorgang beschreiben.

Felder
batch

string

Name des Batches für den Vorgang.
batch_uuid

string

UUID des Batches für den Vorgang.
create_time

Timestamp

Die Uhrzeit, zu der der Vorgang erstellt wurde.
done_time

Timestamp

Der Zeitpunkt, zu dem der Vorgang abgeschlossen wurde.
operation_type

BatchOperationType

Der Vorgangstyp.
description

string

Kurze Beschreibung des Vorgangs.
labels

map<string, string>

Mit dem Vorgang verknüpfte Labels.
warnings[]

string

Warnungen, die während der Ausführung des Vorgangs aufgetreten sind.

BatchOperationType

Vorgangstyp für Batchressourcen

Enums
BATCH_OPERATION_TYPE_UNSPECIFIED Der Typ des Batchvorgangs ist unbekannt.
BATCH Typ des Batchvorgangs.

CreateBatchRequest

Eine Anfrage zum Erstellen einer Batcharbeitslast.

Felder
parent

string

Pflichtangabe. Die übergeordnete Ressource, in der dieser Batch erstellt wird.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • dataproc.batches.create
batch

Batch

Pflichtangabe. Der zu erstellende Batch.
batch_id

string

Optional. Die für den Batch zu verwendende ID, die als letzte Komponente des Ressourcennamens des Batches verwendet wird.

Dieser Wert muss 4 bis 63 Zeichen umfassen. Gültige Zeichen sind /[a-z][0-9]-/.
request_id

string

Optional. Eine eindeutige ID, die zur Identifizierung der Anfrage verwendet wird. Wenn der Dienst zwei CreateBatchRequest-Objekte mit derselben Anfrage-ID empfängt, wird die zweite Anfrage ignoriert und der Vorgang, der dem ersten Batch entspricht, der im Backend erstellt und gespeichert wurde, wird zurückgegeben.

Empfehlung: Legen Sie für diesen Wert eine UUID fest.

Der Wert darf nur Buchstaben (a–z, A–Z), Ziffern (0–9), Unterstriche (_) und Bindestriche (-) enthalten. Die maximale Länge beträgt 40 Zeichen.

CreateSessionRequest

Eine Anfrage zum Erstellen einer Sitzung.

Felder
parent

string

Pflichtangabe. Die übergeordnete Ressource, in der diese Sitzung erstellt wird.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • dataproc.sessions.create
session

Session

Pflichtangabe. Die zu erstellende interaktive Sitzung.
session_id

string

Pflichtangabe. Die für die Sitzung zu verwendende ID, die als letzte Komponente des Ressourcennamens der Sitzung verwendet wird.

Dieser Wert muss 4 bis 63 Zeichen umfassen. Gültige Zeichen sind /[a-z][0-9]-/.
request_id

string

Optional. Eine eindeutige ID, die zur Identifizierung der Anfrage verwendet wird. Wenn der Dienst zwei CreateSessionRequests mit derselben ID empfängt, wird die zweite Anfrage ignoriert und die erste Session wird erstellt und im Backend gespeichert.

Empfehlung: Legen Sie für diesen Wert eine UUID fest.

Der Wert darf nur Buchstaben (a–z, A–Z), Ziffern (0–9), Unterstriche (_) und Bindestriche (-) enthalten. Die maximale Länge beträgt 40 Zeichen.

CreateSessionTemplateRequest

Eine Anfrage zum Erstellen einer Sitzungsvorlage.

Felder
parent

string

Pflichtangabe. Die übergeordnete Ressource, in der diese Sitzungsvorlage erstellt wird.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • dataproc.sessionTemplates.create
session_template

SessionTemplate

Pflichtangabe. Die zu erstellende Sitzungsvorlage.

DeleteBatchRequest

Eine Anfrage zum Löschen einer Batcharbeitslast.

Felder
name

string

Pflichtangabe. Der voll qualifizierte Name des abzurufenden Batches im Format „projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID“

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • dataproc.batches.delete

DeleteSessionRequest

Eine Anfrage zum Löschen einer Sitzung.

Felder
name

string

Pflichtangabe. Der Name der zu löschenden Sitzungsressource.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • dataproc.sessions.delete
request_id

string

Optional. Eine eindeutige ID, die zur Identifizierung der Anfrage verwendet wird. Wenn der Dienst zwei DeleteSessionRequest-Anfragen mit derselben ID erhält, wird die zweite Anfrage ignoriert.

Empfehlung: Legen Sie für diesen Wert eine UUID fest.

Der Wert darf nur Buchstaben (a–z, A–Z), Ziffern (0–9), Unterstriche (_) und Bindestriche (-) enthalten. Die maximale Länge beträgt 40 Zeichen.

DeleteSessionTemplateRequest

Eine Anfrage zum Löschen einer Sitzungsvorlage.

Felder
name

string

Pflichtangabe. Der Name der zu löschenden Sitzungsvorlage.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • dataproc.sessionTemplates.delete

DiagnoseClusterResults

Der Speicherort der Diagnoseausgabe.

Felder
output_uri

string

Nur Ausgabe. Der Cloud Storage-URI der Diagnoseausgabe. Der Ausgabebericht ist eine Nur-Text-Datei mit einer Zusammenfassung der erfassten Diagnosen.

EnvironmentConfig

Umgebungskonfiguration für eine Arbeitslast.

Felder
execution_config

ExecutionConfig

Optional. Ausführungskonfiguration für eine Arbeitslast.
peripherals_config

PeripheralsConfig

Optional. Konfiguration der Peripheriegeräte, auf die die Arbeitslast Zugriff hat.

ExecutionConfig

Ausführungskonfiguration für eine Arbeitslast.

Felder
service_account

string

Optional. Das Dienstkonto, das zum Ausführen der Arbeitslast verwendet wurde.
network_tags[]

string

Optional. Tags, die für die Steuerung des Netzwerktraffics verwendet werden.
kms_key

string

Optional. Der Cloud KMS-Schlüssel, der für die Verschlüsselung verwendet werden soll.
idle_ttl

Duration

Optional. Gilt nur für Sitzungen. Die Dauer, während der die Sitzung im Inaktivitätsstatus aktiv bleibt. Wird dieser Grenzwert überschritten, wird die Sitzung beendet. Dieses Feld kann nicht für eine Batch-Arbeitslast festgelegt werden. Der Mindestwert ist 10 Minuten, der Höchstwert 14 Tage (siehe JSON-Darstellung von Duration). Wenn kein Wert festgelegt ist, wird standardmäßig 1 Stunde verwendet. Wenn für eine interaktive Sitzung sowohl ttl als auch idle_ttl angegeben sind, werden die Bedingungen als OR-Bedingungen behandelt: Die Arbeitslast wird beendet, wenn sie idle_ttl lang inaktiv war oder ttl überschritten wurde, je nachdem, was zuerst eintritt.
ttl

Duration

Optional. Die Dauer, nach der die Arbeitslast beendet wird, angegeben als JSON-Darstellung für Dauer. Wenn die Arbeitslast diese Dauer überschreitet, wird sie bedingungslos beendet, ohne dass auf den Abschluss der laufenden Arbeit gewartet wird. Wenn für eine Batcharbeitslast kein ttl angegeben ist, wird die Arbeitslast so lange ausgeführt, bis sie von selbst beendet wird (oder sie läuft ewig weiter, ohne beendet zu werden). Wenn ttl für eine interaktive Sitzung nicht angegeben ist, wird standardmäßig 24 Stunden verwendet. Wenn ttl für einen Batch, für den die Laufzeitversion 2.1 oder höher verwendet wird, nicht angegeben ist, wird standardmäßig 4 Stunden verwendet. Der Mindestwert beträgt 10 Minuten, der Höchstwert 14 Tage. Wenn sowohl ttl als auch idle_ttl für eine interaktive Sitzung angegeben sind, werden die Bedingungen als OR-Bedingungen behandelt: Die Arbeitslast wird beendet, wenn sie idle_ttl Minuten lang inaktiv war oder ttl überschritten wurde, je nachdem, was zuerst eintritt.
staging_bucket

string

Optional. Ein Cloud Storage-Bucket, der zum Staging von Arbeitslastabhängigkeiten, Konfigurationsdateien und zum Speichern von Arbeitslastausgaben und anderen sitzungsspezifischen Daten wie Spark-Verlaufsdateien verwendet wird. Wenn Sie keinen Staging-Bucket angeben, ermittelt Cloud Dataproc einen Cloud Storage-Speicherort entsprechend der Region, in der Ihre Arbeitslast ausgeführt wird. Anschließend werden Staging- und temporäre Buckets auf Projektebene pro Speicherort erstellt und verwaltet. Für dieses Feld ist der Name eines Cloud Storage-Buckets erforderlich, kein gs://...-URI für einen Cloud Storage-Bucket.
Union-Feld network. Netzwerkkonfiguration für die Ausführung der Arbeitslast. Für network ist nur einer der folgenden Werte zulässig:
network_uri

string

Optional. Netzwerk-URI, mit dem die Arbeitslast verbunden werden soll.
subnetwork_uri

string

Optional. Der URI des Subnetzwerks, mit dem die Arbeitslast verbunden werden soll.

GetBatchRequest

Eine Anfrage zum Abrufen der Ressourcendarstellung für eine Batcharbeitslast.

Felder
name

string

Pflichtangabe. Der voll qualifizierte Name des abzurufenden Batches im Format „projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID“

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • dataproc.batches.get

GetSessionRequest

Eine Anfrage zum Abrufen der Ressourcendarstellung für eine Sitzung.

Felder
name

string

Pflichtangabe. Der Name der Sitzung, die abgerufen werden soll.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • dataproc.sessions.get

GetSessionTemplateRequest

Eine Anfrage zum Abrufen der Ressourcendarstellung für eine Sitzungsvorlage.

Felder
name

string

Pflichtangabe. Der Name der Sitzungsvorlage, die abgerufen werden soll.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • dataproc.sessionTemplates.get

JupyterConfig

Jupyter-Konfiguration für eine interaktive Sitzung.

Felder
kernel

Kernel

Optional. Kernel
display_name

string

Optional. Anzeigename, der auf der Jupyter-Kernelspec-Karte angezeigt wird.

Kernel

Jupyter-Kerneltypen

Enums
KERNEL_UNSPECIFIED Der Kernel ist unbekannt.
PYTHON Python-Kernel
SCALA Scala-Kernel

ListBatchesRequest

Eine Anfrage zum Auflisten von Batcharbeitslasten in einem Projekt.

Felder
parent

string

Pflichtangabe. Das übergeordnete Element, das dieser Sammlung von Batches zugewiesen ist.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • dataproc.batches.list
page_size

int32

Optional. Die maximale Anzahl von Batches, die in jeder Antwort zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Die Standardseitengröße ist 20, die maximale Seitengröße ist 1.000.
page_token

string

Optional. Ein Seitentoken, das von einem vorherigen ListBatches-Aufruf empfangen wurde. Geben Sie dieses Token an, um die nachfolgende Seite abzurufen.
filter

string

Optional. Ein Filter für die Batches, die in der Antwort zurückgegeben werden sollen.

Ein Filter ist ein logischer Ausdruck, der die Werte verschiedener Felder in jeder Batchressource einschränkt. Bei Filtern wird die Groß- und Kleinschreibung berücksichtigt. Sie können mehrere Klauseln mit logischen Operatoren (AND/OR) enthalten. Unterstützte Felder sind batch_id, batch_uuid, state, create_time und labels.

Beispiel: state = RUNNING and create_time < "2023-01-01T00:00:00Z" filtert für Batches im Status „RUNNING“, die vor dem 01.01. 2023 erstellt wurden. state = RUNNING and labels.environment=production filtert nach Batches im Status „RUNNING“ (AKTIV), die ein Label für die Produktionsumgebung haben.

Eine detaillierte Beschreibung der Filtersyntax und eine Liste der unterstützten Vergleiche finden Sie unter https://google.aip.dev/assets/misc/ebnf-filtering.txt.
order_by

string

Optional. Feld(er), nach dem bzw. denen die Liste der Batches sortiert werden soll.

Derzeit werden nur die Sortierungen „nicht angegeben“ (leer) und create_time desc unterstützt, um nach den zuletzt erstellten Batches zu sortieren.

Weitere Informationen finden Sie unter https://google.aip.dev/132#ordering.

ListBatchesResponse

Eine Liste von Batcharbeitslasten.

Felder
batches[]

Batch

Nur Ausgabe. Die Batches aus der angegebenen Sammlung.
next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.
unreachable[]

string

Nur Ausgabe. Liste der Batches, die nicht in die Antwort aufgenommen werden konnten. Wenn Sie versuchen, eine dieser Ressourcen abzurufen, kann das Aufschluss darüber geben, warum sie nicht in der Listenantwort enthalten war.

ListSessionTemplatesRequest

Eine Anfrage zum Auflisten von Sitzungsvorlagen in einem Projekt.

Felder
parent

string

Pflichtangabe. Das übergeordnete Element, dem diese Sammlung von Sitzungsvorlagen zugewiesen ist.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • dataproc.sessionTemplates.list
page_size

int32

Optional. Die maximale Anzahl von Sitzungen, die in jeder Antwort zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.
page_token

string

Optional. Ein Seitentoken, das von einem vorherigen ListSessions-Aufruf empfangen wurde. Geben Sie dieses Token an, um die nachfolgende Seite abzurufen.
filter

string

Optional. Ein Filter für die Sitzungsvorlagen, die in der Antwort zurückgegeben werden sollen. Bei Filtern wird die Groß-/Kleinschreibung beachtet. Sie haben folgende Syntax:

[Feld = Wert] UND [Feld [= Wert]] ...

ListSessionTemplatesResponse

Eine Liste mit Sitzungsvorlagen.

Felder
session_templates[]

SessionTemplate

Nur Ausgabe. Liste der Sitzungsvorlagen
next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

ListSessionsRequest

Eine Anfrage zum Auflisten von Sitzungen in einem Projekt.

Felder
parent

string

Pflichtangabe. Das übergeordnete Element, das dieser Sammlung von Sitzungen zugewiesen ist.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • dataproc.sessions.list
page_size

int32

Optional. Die maximale Anzahl von Sitzungen, die in jeder Antwort zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.
page_token

string

Optional. Ein Seitentoken, das von einem vorherigen ListSessions-Aufruf empfangen wurde. Geben Sie dieses Token an, um die nachfolgende Seite abzurufen.
filter

string

Optional. Ein Filter für die Sitzungen, die in der Antwort zurückgegeben werden sollen.

Ein Filter ist ein logischer Ausdruck, der die Werte verschiedener Felder in jeder Sitzungsressource einschränkt. Bei Filtern wird die Groß- und Kleinschreibung berücksichtigt. Sie können mehrere Klauseln mit logischen Operatoren (AND, OR) enthalten. Unterstützte Felder sind session_id, session_uuid, state, create_time und labels.

Beispiel: state = ACTIVE and create_time < "2023-01-01T00:00:00Z" ist ein Filter für Sitzungen im Status „AKTIV“, die vor dem 01.01.2023 erstellt wurden. state = ACTIVE and labels.environment=production ist ein Filter für Sitzungen im Status „AKTIV“, die ein Label für die Produktionsumgebung haben.

Eine detaillierte Beschreibung der Filtersyntax und eine Liste der unterstützten Vergleichsoperatoren finden Sie unter https://google.aip.dev/assets/misc/ebnf-filtering.txt.

ListSessionsResponse

Eine Liste interaktiver Sitzungen.

Felder
sessions[]

Session

Nur Ausgabe. Die Sitzungen aus der angegebenen Sammlung.
next_page_token

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

PeripheralsConfig

Konfiguration von Hilfsdiensten für eine Arbeitslast.

Felder
metastore_service

string

Optional. Ressourcenname eines vorhandenen Dataproc Metastore-Dienstes.

Beispiel:

  • projects/[project_id]/locations/[region]/services/[service_id]
spark_history_server_config

SparkHistoryServerConfig

Optional. Die Spark-Verlaufsserverkonfiguration für die Arbeitslast.

PyPiRepositoryConfig

Konfiguration für das PyPi-Repository

Felder
pypi_repository

string

Optional. PyPi-Repository-Adresse

PySparkBatch

Eine Konfiguration zum Ausführen einer Apache PySpark-Batcharbeitslast.

Felder
main_python_file_uri

string

Pflichtangabe. Der HCFS-URI der Python-Hauptdatei, die als Spark-Treiber verwendet werden soll. Muss eine .py-Datei sein.
args[]

string

Optional. Argumente, die an den Treiber übergeben werden sollen. Fügen Sie keine Argumente hinzu, die als Batch-Eigenschaften festgelegt werden können, z. B. --conf, da es sonst zu einer Kollision kommen kann, die eine falsche Batch-Einreichung verursacht.
python_file_uris[]

string

Optional. HCFS-Datei-URIs von Python-Dateien, die an das PySpark-Framework übergeben werden sollen. Unterstützte Dateitypen: .py, .egg und .zip.
jar_file_uris[]

string

Optional. HCFS-URIs von JAR-Dateien, die dem Klassenpfad des Spark-Treibers und der Spark-Aufgaben hinzugefügt werden sollen.
file_uris[]

string

Optional. HCFS-URIs von Dateien, die im Arbeitsverzeichnis jedes Executors abgelegt werden sollen.
archive_uris[]

string

Optional. HCFS-URIs von Archiven, die in das Arbeitsverzeichnis jedes Executors extrahiert werden sollen. Unterstützte Dateitypen: .jar, .tar, .tar.gz, .tgz und .zip.

RepositoryConfig

Konfiguration für Abhängigkeits-Repositories

Felder
pypi_repository_config

PyPiRepositoryConfig

Optional. Konfiguration für das PyPi-Repository.

RuntimeConfig

Laufzeitkonfiguration für eine Arbeitslast.

Felder
version

string

Optional. Version der Batchlaufzeit.
container_image

string

Optional. Optionales benutzerdefiniertes Container-Image für die Laufzeitumgebung des Jobs. Wenn keine Angabe erfolgt, wird ein Standardcontainer-Image verwendet.
properties

map<string, string>

Optional. Eine Zuordnung von Attributnamen zu Werten, die zum Konfigurieren der Arbeitslastausführung verwendet werden.
repository_config

RepositoryConfig

Optional. Konfiguration des Abhängigkeits-Repositorys
autotuning_config

AutotuningConfig

Optional. Konfiguration der automatischen Optimierung der Arbeitslast
cohort

string

Optional. Kohorten-ID. Hiermit werden Familien von Arbeitslasten mit derselben Form identifiziert, z.B. tägliche ETL-Jobs.

RuntimeInfo

Laufzeitinformationen zur Ausführung der Arbeitslast.

Felder
endpoints

map<string, string>

Nur Ausgabe. Zuordnung von Remotezugriffs-Endpunkten (z. B. Weboberflächen und APIs) zu ihren URIs.
output_uri

string

Nur Ausgabe. Ein URI, der auf den Speicherort von stdout und stderr der Arbeitslast verweist.
diagnostic_output_uri

string

Nur Ausgabe. Ein URI, der auf den Speicherort des Diagnose-Tarballs verweist.
approximate_usage

UsageMetrics

Nur Ausgabe. Ungefähre Ressourcennutzung der Arbeitslast, berechnet, wenn die Arbeitslast abgeschlossen ist (siehe Dataproc Serverless-Preise).

Hinweis:Dieser Messwert kann sich in Zukunft ändern, z. B. um den kumulativen Ressourcenverbrauch der Arbeitslast während der Ausführung der Arbeitslast zu erfassen. Ankündigungen, Änderungen, Fehlerkorrekturen und andere Entwicklungen bei Dataproc finden Sie in den Releasenotes zu Dataproc Serverless.
current_usage

UsageSnapshot

Nur Ausgabe. Snapshot der aktuellen Ressourcennutzung der Arbeitslast.

Session

Eine Darstellung einer Sitzung.

Felder
name

string

Pflichtangabe. Der Ressourcenname der Sitzung.
uuid

string

Nur Ausgabe. Eine Sitzungs-UUID (Unique Universal Identifier). Der Dienst generiert diesen Wert, wenn er die Sitzung erstellt.
create_time

Timestamp

Nur Ausgabe. Die Uhrzeit, zu der die Sitzung erstellt wurde.
runtime_info

RuntimeInfo

Nur Ausgabe. Laufzeitinformationen zur Sitzungsausführung.
state

State

Nur Ausgabe. Ein Sitzungsstatus.
state_message

string

Nur Ausgabe. Details zum Sitzungsstatus, z. B. die Fehlerbeschreibung, wenn der Status FAILED ist.
state_time

Timestamp

Nur Ausgabe. Der Zeitpunkt, zu dem die Sitzung den aktuellen Status erreicht hat.
creator

string

Nur Ausgabe. Die E-Mail-Adresse des Nutzers, der die Sitzung erstellt hat.
labels

map<string, string>

Optional. Die Labels, die der Sitzung zugeordnet werden sollen. Labelschlüssel müssen zwischen 1 und 63 Zeichen lang sein und RFC 1035 entsprechen. Labelwerte können leer sein. Wenn sie vorhanden sind, müssen sie zwischen 1 und 63 Zeichen lang sein und RFC 1035 entsprechen. Einer Sitzung können maximal 32 Labels zugeordnet werden.
runtime_config

RuntimeConfig

Optional. Laufzeitkonfiguration für die Sitzungsausführung.
environment_config

EnvironmentConfig

Optional. Umgebungskonfiguration für die Sitzungsausführung.
user

string

Optional. Die E-Mail-Adresse des Nutzers, dem die Sitzung gehört.
state_history[]

SessionStateHistory

Nur Ausgabe. Informationen zum bisherigen Status der Sitzung.
session_template

string

Optional. Die von der Sitzung verwendete Sitzungsvorlage.

Nur Ressourcennamen, einschließlich Projekt-ID und Standort, sind zulässig.

Beispiel: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]

Die Vorlage muss sich im selben Projekt und in derselben Dataproc-Region wie die Sitzung befinden.
Union-Feld session_config. Die Sitzungskonfiguration. Für session_config ist nur einer der folgenden Werte zulässig:
jupyter_session

JupyterConfig

Optional. Konfiguration der Jupyter-Sitzung.
spark_connect_session

SparkConnectConfig

Optional. Konfiguration der Spark Connect-Sitzung.

SessionStateHistory

Informationen zum bisherigen Status.

Felder
state

State

Nur Ausgabe. Der Status der Sitzung an diesem Punkt im Sitzungsverlauf.
state_message

string

Nur Ausgabe. Details zum Status an diesem Punkt im Sitzungsverlauf.
state_start_time

Timestamp

Nur Ausgabe. Der Zeitpunkt, zu dem die Sitzung in den bisherigen Status gewechselt ist.

Bundesland

Der Sitzungsstatus.

Enums
STATE_UNSPECIFIED Der Sitzungsstatus ist unbekannt.
CREATING Die Sitzung wird vor dem Ausführen erstellt.
ACTIVE Die Sitzung wird ausgeführt.
TERMINATING Die Sitzung wird beendet.
TERMINATED Die Sitzung wird beendet.
FAILED Die Sitzung wird aufgrund eines Fehlers nicht mehr ausgeführt.

SessionOperationMetadata

Metadaten, die den Sitzungsvorgang beschreiben.

Felder
session

string

Name der Sitzung für den Vorgang.
session_uuid

string

Die Sitzungs-UUID für den Vorgang.
create_time

Timestamp

Die Uhrzeit, zu der der Vorgang erstellt wurde.
done_time

Timestamp

Der Zeitpunkt, zu dem der Vorgang abgeschlossen wurde.
operation_type

SessionOperationType

Der Vorgangstyp.
description

string

Kurze Beschreibung des Vorgangs.
labels

map<string, string>

Mit dem Vorgang verknüpfte Labels.
warnings[]

string

Warnungen, die während der Ausführung des Vorgangs aufgetreten sind.

SessionOperationType

Vorgangstyp für Sitzungsressourcen

Enums
SESSION_OPERATION_TYPE_UNSPECIFIED Der Sitzungsvorgangstyp ist unbekannt.
CREATE Vorgangstyp „Sitzung erstellen“
TERMINATE Vorgangstyp „Sitzung beenden“.
DELETE Löschen Sie den Vorgangstyp „Sitzung“.

SessionTemplate

Eine Darstellung einer Sitzungsvorlage.

Felder
name

string

Pflichtangabe. Der Ressourcenname der Sitzungsvorlage.
description

string

Optional. Kurze Beschreibung der Vorlage.
create_time

Timestamp

Nur Ausgabe. Die Uhrzeit, zu der die Vorlage erstellt wurde.
creator

string

Nur Ausgabe. Die E-Mail-Adresse des Nutzers, der die Vorlage erstellt hat.
labels

map<string, string>

Optional. Labels, die mit Sitzungen verknüpft werden sollen, die mit dieser Vorlage erstellt wurden. Labelschlüssel müssen zwischen 1 und 63 Zeichen lang sein und RFC 1035 entsprechen. Labelwerte können leer sein. Wenn sie vorhanden sind, müssen sie zwischen 1 und 63 Zeichen lang sein und RFC 1035 entsprechen. Einer Sitzung können maximal 32 Labels zugeordnet werden.
runtime_config

RuntimeConfig

Optional. Laufzeitkonfiguration für die Sitzungsausführung.
environment_config

EnvironmentConfig

Optional. Umgebungskonfiguration für die Sitzungsausführung.
update_time

Timestamp

Nur Ausgabe. Der Zeitpunkt, zu dem die Vorlage zuletzt aktualisiert wurde.
uuid

string

Nur Ausgabe. UUID (Unique Universal Identifier) einer Sitzungsvorlage. Der Dienst generiert diesen Wert beim Erstellen der Sitzungsvorlage.
Union-Feld session_config. Die Sitzungskonfiguration. Für session_config ist nur einer der folgenden Werte zulässig:
jupyter_session

JupyterConfig

Optional. Konfiguration der Jupyter-Sitzung.
spark_connect_session

SparkConnectConfig

Optional. Konfiguration der Spark Connect-Sitzung.

SparkBatch

Eine Konfiguration zum Ausführen einer Apache Spark-Batcharbeitslast.

Felder
args[]

string

Optional. Argumente, die an den Treiber übergeben werden sollen. Fügen Sie keine Argumente hinzu, die als Batch-Eigenschaften festgelegt werden können, z. B. --conf, da es sonst zu einer Kollision kommen kann, die eine falsche Batch-Einreichung verursacht.
jar_file_uris[]

string

Optional. HCFS-URIs von JAR-Dateien, die dem Klassenpfad des Spark-Treibers und der Spark-Aufgaben hinzugefügt werden sollen.
file_uris[]

string

Optional. HCFS-URIs von Dateien, die im Arbeitsverzeichnis jedes Executors abgelegt werden sollen.
archive_uris[]

string

Optional. HCFS-URIs von Archiven, die in das Arbeitsverzeichnis jedes Executors extrahiert werden sollen. Unterstützte Dateitypen: .jar, .tar, .tar.gz, .tgz und .zip.
Union-Feld driver. Die Angabe der Hauptmethode, die zum Ausführen der Spark-Arbeitslast aufgerufen werden soll. Geben Sie entweder die JAR-Datei mit der Hauptklasse oder den Namen der Hauptklasse an. Wenn Sie sowohl eine Haupt-JAR-Datei als auch eine Hauptklasse in dieser JAR-Datei übergeben möchten, fügen Sie die JAR-Datei zu jar_file_uris hinzu und geben Sie dann den Namen der Hauptklasse in main_class an. Für driver ist nur einer der folgenden Werte zulässig:
main_jar_file_uri

string

Optional. Der HCFS-URI der JAR-Datei, die die Hauptklasse enthält.
main_class

string

Optional. Der Name der Hauptklasse des Treibers. Die JAR-Datei, die die Klasse enthält, muss sich im Klassenpfad befinden oder in jar_file_uris angegeben sein.

SparkConnectConfig

Dieser Typ hat keine Felder.

Spark Connect-Konfiguration für eine interaktive Sitzung

SparkHistoryServerConfig

Spark History Server-Konfiguration für die Arbeitslast.

Felder
dataproc_cluster

string

Optional. Ressourcenname eines vorhandenen Dataproc-Clusters, der als Spark-Verlaufsserver für die Arbeitslast dient.

Beispiel:

  • projects/[project_id]/regions/[region]/clusters/[cluster_name]

SparkRBatch

Eine Konfiguration zum Ausführen einer Apache SparkR-Batcharbeitslast.

Felder
main_r_file_uri

string

Pflichtangabe. Der HCFS-URI der Haupt-R-Datei, die als Treiber verwendet werden soll. Muss eine .R- oder .r-Datei sein.
args[]

string

Optional. Argumente, die an den Spark-Treiber übergeben werden. Fügen Sie keine Argumente hinzu, die als Batch-Eigenschaften festgelegt werden können, z. B. --conf, da es sonst zu einer Kollision kommen kann, die eine falsche Batch-Einreichung verursacht.
file_uris[]

string

Optional. HCFS-URIs von Dateien, die im Arbeitsverzeichnis jedes Executors abgelegt werden sollen.
archive_uris[]

string

Optional. HCFS-URIs von Archiven, die in das Arbeitsverzeichnis jedes Executors extrahiert werden sollen. Unterstützte Dateitypen: .jar, .tar, .tar.gz, .tgz und .zip.

SparkSqlBatch

Eine Konfiguration zum Ausführen von Apache Spark SQL-Abfragen als Batch-Arbeitslast.

Felder
query_file_uri

string

Pflichtangabe. Die HCFS-URI des Scripts, das die auszuführenden Spark SQL-Abfragen enthält.
query_variables

map<string, string>

Optional. Zuordnung von Namen von Abfragevariablen zu Werten (entspricht dem Spark SQL-Befehl SET name="value";).
jar_file_uris[]

string

Optional. HCFS-URIs von JAR-Dateien, die dem Spark-CLASSPATH hinzugefügt werden sollen.

TerminateSessionRequest

Eine Anfrage zum Beenden einer interaktiven Sitzung.

Felder
name

string

Pflichtangabe. Der Name der Sitzungsressource, die beendet werden soll.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • dataproc.sessions.terminate
request_id

string

Optional. Eine eindeutige ID, die zur Identifizierung der Anfrage verwendet wird. Wenn der Dienst zwei TerminateSessionRequest-Anfragen mit derselben ID empfängt, wird die zweite Anfrage ignoriert.

Empfehlung: Legen Sie für diesen Wert eine UUID fest.

Der Wert darf nur Buchstaben (a–z, A–Z), Ziffern (0–9), Unterstriche (_) und Bindestriche (-) enthalten. Die maximale Länge beträgt 40 Zeichen.

UpdateSessionTemplateRequest

Eine Anfrage zum Aktualisieren einer Sitzungsvorlage.

Felder
session_template

SessionTemplate

Pflichtangabe. Die aktualisierte Sitzungsvorlage.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource sessionTemplate erforderlich:

  • dataproc.sessionTemplates.update

UsageMetrics

Nutzungsmesswerte geben die ungefähre Gesamtmenge der von einer Arbeitslast verbrauchten Ressourcen an.

Felder
milli_dcu_seconds

int64

Optional. DCU-Nutzung (Dataproc Compute Units) in (milliDCU × seconds) (siehe Dataproc Serverless-Preise).
shuffle_storage_gb_seconds

int64

Optional. Shuffle-Speichernutzung in (GB × seconds) (siehe Dataproc Serverless-Preise).
milli_accelerator_seconds

int64

Optional. Beschleunigernutzung in (milliAccelerator × seconds) (siehe Dataproc Serverless-Preise).
accelerator_type

string

Optional. Verwendeter Beschleunigertyp, falls zutreffend

UsageSnapshot

Der Nutzungs-Snapshot stellt die Ressourcen dar, die von einer Arbeitslast zu einem bestimmten Zeitpunkt verbraucht wurden.

Felder
milli_dcu

int64

Optional. Milli (ein Tausendstel) Dataproc-Recheneinheiten (DCU) (siehe Dataproc Serverless-Preise).
shuffle_storage_gb

int64

Optional. Speicherplatz für Zufallsmix in Gigabyte (GB). (siehe Dataproc Serverless-Preise)
milli_dcu_premium

int64

Optional. Milli (ein Tausendstel) Dataproc Compute Units (DCU), die zum Premium-Tarif berechnet werden (siehe Dataproc Serverless-Preise).
shuffle_storage_gb_premium

int64

Optional. Shuffle-Speicherplatz in Gigabyte (GB), der in der Premium-Stufe in Rechnung gestellt wird. (siehe Dataproc Serverless-Preise)
milli_accelerator

int64

Optional. Milli (ein Tausendstel) Beschleuniger. (siehe Dataproc Serverless-Preise)
accelerator_type

string

Optional. Verwendeter Beschleunigertyp, falls zutreffend
snapshot_time

Timestamp

Optional. Der Zeitstempel des Nutzungs-Snapshots.