Method: projects.locations.apps.importApp

Importiert die angegebene App.

HTTP-Anfrage

POST https://ces.googleapis.com/v1beta/{parent=projects/*/locations/*}/apps:importApp

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Name der übergeordneten Ressource mit dem Speicherort der zu importierenden App.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "displayName": string,
  "appId": string,
  "importOptions": {
    object (ImportAppRequest.ImportOptions)
  },
  "ignoreAppLock": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsUri": string,
  "appContent": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "jsonPatchContent": string,
  "jsonPatchGcsUri": string
  // End of mutually exclusive fields.
}
Felder
displayName

string

Optional. Der Anzeigename der zu importierenden App. * Wenn die App beim Import erstellt wird und der Anzeigename angegeben ist, wird dieser für die importierte App verwendet. Wenn ein Konflikt mit einer vorhandenen App erkannt wird, wird dem Anzeigenamen ein Zeitstempel angehängt, um ihn eindeutig zu machen. * Wenn die App ein Reimport ist, sollte dieses Feld nicht festgelegt werden. Wenn Sie beim Reimport einen Anzeigenamen angeben, wird der Fehler INVALID_ARGUMENT zurückgegeben.
appId

string

Optional. Die ID für die importierte App. * Wenn sie nicht angegeben ist, wird der App automatisch eine eindeutige ID zugewiesen. * Andernfalls wird diese ID als letzte Komponente des Ressourcennamens der importierten App verwendet. Wenn am angegebenen Speicherort im Projekt bereits eine App mit derselben ID vorhanden ist, wird der Inhalt der vorhandenen App ersetzt.
importOptions

object (ImportAppRequest.ImportOptions)

Optional. Optionen für den Importvorgang für die App.
ignoreAppLock

boolean

Optional. Flag zum Außerkraftsetzen der App-Sperre während des Imports. Wenn auf „true“ gesetzt, wird die App-Sperre beim Importvorgang ignoriert.
Die zu importierende App. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
gcsUri

string

Der Google Cloud Storage-URI, aus dem die App importiert werden soll. Das Format dieses URI muss gs://<bucket-name>/<object-name> sein.
appContent

string (bytes format)

Rohe Byte, die die komprimierte ZIP-Datei mit der Ordnerstruktur der App darstellen.

Ein base64-codierter String.
Ende der sich gegenseitig ausschließenden Felder.
Die JSON-Patches, die auf die importierte App angewendet werden sollen. Im Folgenden finden Sie eine Liste mit sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
jsonPatchContent

string

Optional. Patch-Inhalt als JSON-String.
jsonPatchGcsUri

string

Optional. Ein Cloud Storage-URI, der auf eine JSON-Datei mit den Patches verweist.
Ende der sich gegenseitig ausschließenden Felder.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • ces.apps.import

Weitere Informationen finden Sie in der IAM-Dokumentation.

ImportAppRequest.ImportOptions

Konfigurationsoptionen für den App-Import. Mit diesen Optionen wird das Importverhalten gesteuert, insbesondere wenn Konflikte mit vorhandenen App-Daten auftreten.

JSON-Darstellung 
{
  "conflictResolutionStrategy": enum (ImportAppRequest.ImportOptions.ConflictResolutionStrategy),
  "validateOnly": boolean
}
Felder
conflictResolutionStrategy

enum (ImportAppRequest.ImportOptions.ConflictResolutionStrategy)

Optional. Die Strategie, die beim Beheben von Konflikten während des Imports verwendet werden soll.
validateOnly

boolean

Optional. Flagge für den Testlauf des Importvorgangs. Wenn der Wert auf „true“ gesetzt ist, werden beim Importvorgang nur Validierungen durchgeführt. Es werden keine Änderungen an der vorhandenen App vorgenommen und keine neue App erstellt.

ImportAppRequest.ImportOptions.ConflictResolutionStrategy

Definiert die Strategie für den Umgang mit Konflikten, wenn eine App mit derselben ID bereits vorhanden ist oder wenn importierte Ressourcen (z. B. Agents, Tools usw.) dieselben Anzeigenamen wie vorhandene Ressourcen in dieser App haben.

Enums
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED Die Strategie zur Konfliktlösung ist nicht angegeben.
REPLACE Vorhandene Daten durch importierte Daten ersetzen Wenn bereits eine App mit demselben appId vorhanden ist, werden ihre Inhalte basierend auf der importierten App aktualisiert. Ressourcen (App, Agents, Tools, Beispiele, Guardrails, Toolsets) in der importierten App, die denselben Anzeigenamen wie vorhandene Ressourcen haben, überschreiben die vorhandenen Ressourcen. – Importierte Ressourcen mit neuen Anzeigenamen werden erstellt. – Vorhandene Ressourcen, die in der importierten App keinen passenden Anzeigenamen haben, bleiben unverändert.
OVERWRITE Vorhandene Daten mit importierten Daten überschreiben Wenn bereits eine App mit derselben appId vorhanden ist, werden ihre Inhalte mit der importierten App überschrieben. Vorhandene Ressourcen (Agents, Tools, Beispiele, Schutzmaßnahmen, Toolsets) in der App werden gelöscht. – Importierte Ressourcen werden als neue Ressourcen erstellt.