REST Resource: projects.locations.targets

Risorsa: destinazione

Una risorsa Target nell'API Cloud Deploy.

Un Target definisce una località in cui è possibile eseguire il deployment di una configurazione Skaffold.

Rappresentazione JSON 
{
  "name": string,
  "targetId": string,
  "uid": string,
  "description": string,
  "annotations": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "requireApproval": boolean,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionConfigs": [
    {
      object (ExecutionConfig)
    }
  ],
  "deployParameters": {
    string: string,
    ...
  },

  // Union field deployment_target can be only one of the following:
  "gke": {
    object (GkeCluster)
  },
  "anthosCluster": {
    object (AnthosCluster)
  },
  "run": {
    object (CloudRunLocation)
  },
  "multiTarget": {
    object (MultiTarget)
  },
  "customTarget": {
    object (CustomTarget)
  }
  // End of list of possible types for union field deployment_target.
}
Campi
name

string

Facoltativo. Nome di Target. Il formato è projects/{project}/locations/{location}/targets/{target}. Il componente target deve corrispondere a [a-z]([a-z0-9-]{0,61}[a-z0-9])?
targetId

string

Solo output. ID risorsa di Target.
uid

string

Solo output. Identificatore univoco di Target.
description

string

Facoltativo. Descrizione del Target. La lunghezza massima è di 255 caratteri.
annotations

map (key: string, value: string)

Facoltativo. Annotazioni dell'utente. Questi attributi possono essere impostati e utilizzati solo dall'utente e non da Cloud Deploy. Consulta la pagina https://google.aip.dev/128#annotations per ulteriori dettagli quali le limitazioni relative a formato e dimensioni.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
labels

map (key: string, value: string)

Facoltativo. Le etichette sono attributi che possono essere impostati e utilizzati sia dall'utente sia da Cloud Deploy. Le etichette devono soddisfare i seguenti vincoli:

  • Le chiavi e i valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini.
  • Tutti i caratteri devono utilizzare la codifica UTF-8 e sono consentiti caratteri internazionali.
  • Le chiavi devono iniziare con una lettera minuscola o un carattere internazionale.
  • Ogni risorsa è limitata a un massimo di 64 etichette.

Sia le chiavi che i valori sono vincolati a essere inoltre <= 128 byte.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
requireApproval

boolean

Facoltativo. Indica se Target richiede o meno l'approvazione.
createTime

string (Timestamp format)

Solo output. Ora in cui è stato creato l'elemento Target.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Solo output. Ora più recente dell'aggiornamento di Target.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
etag

string

Facoltativo. Questo checksum viene calcolato dal server in base al valore di altri campi e può essere inviato in caso di richieste di aggiornamento ed eliminazione per garantire che il client abbia un valore aggiornato prima di procedere.
executionConfigs[]

object (ExecutionConfig)

Configurazioni per tutte le esecuzioni correlate a questo Target. Ogni valore ExecutionEnvironmentUsage può essere utilizzato in un'unica configurazione; utilizzare lo stesso valore più volte è un errore. Quando vengono specificate una o più configurazioni, è necessario includere i valori ExecutionEnvironmentUsage di RENDER e DEPLOY. Se non viene specificata alcuna configurazione, l'esecuzione utilizzerà il valore predefinito specificato in DefaultPool.
deployParameters

map (key: string, value: string)

Facoltativo. I parametri di deployment da utilizzare per questa destinazione.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Campo di unione deployment_target. Destinazione a cui viene applicata la configurazione Skaffold durante un'implementazione. deployment_target può essere solo uno dei seguenti:
gke

object (GkeCluster)

Facoltativo. Informazioni che specificano un cluster GKE.
anthosCluster

object (AnthosCluster)

Facoltativo. Informazioni che specificano un cluster Anthos.
run

object (CloudRunLocation)

Facoltativo. Informazioni che specificano una destinazione di deployment Cloud Run.
multiTarget

object (MultiTarget)

Facoltativo. Informazioni che specificano un target multiplo.
customTarget

object (CustomTarget)

Facoltativo. Informazioni che specificano un target personalizzato.

GkeCluster

Informazioni che specificano un cluster GKE.

Rappresentazione JSON 
{
  "cluster": string,
  "internalIp": boolean
}
Campi
cluster

string

Facoltativo. Informazioni che specificano un cluster GKE. Il formato è projects/{projectId}/locations/{locationId}/clusters/{cluster_id}.
internalIp

boolean

Facoltativo. Se il valore è true, è possibile accedere a cluster utilizzando l'indirizzo IP privato dell'endpoint del piano di controllo. In caso contrario, viene utilizzato l'indirizzo IP predefinito dell'endpoint del piano di controllo. L'indirizzo IP predefinito è l'indirizzo IP privato per i cluster con endpoint del piano di controllo privati e l'indirizzo IP pubblico negli altri casi.

Specifica questa opzione solo quando cluster è un cluster GKE privato.

AnthosCluster

Informazioni che specificano un cluster Anthos.

Rappresentazione JSON 
{
  "membership": string
}
Campi
membership

string

Facoltativo. Appartenenza al cluster registrato in GKE Hub a cui applicare la configurazione Skaffold. Il formato è projects/{project}/locations/{location}/memberships/{membership_name}.

CloudRunLocation

Informazioni che specificano dove eseguire il deployment di un servizio Cloud Run.

Rappresentazione JSON 
{
  "location": string
}
Campi
location

string

Obbligatorio. La località del servizio Cloud Run. Il formato deve essere projects/{project}/locations/{location}.

MultiTarget

Informazioni che specificano un target multiplo.

Rappresentazione JSON 
{
  "targetIds": [
    string
  ]
}
Campi
targetIds[]

string

Obbligatorio. I targetId di questo target multiplo.

CustomTarget

Informazioni che specificano un target personalizzato.

Rappresentazione JSON 
{
  "customTargetType": string
}
Campi
customTargetType

string

Obbligatorio. Il nome del CustomTargetType. Il formato deve essere projects/{project}/locations/{location}/customTargetTypes/{customTargetType}.

ExecutionConfig

Configurazione dell'ambiente da utilizzare per la chiamata a Skaffold.

Rappresentazione JSON 
{
  "usages": [
    enum (ExecutionEnvironmentUsage)
  ],
  "workerPool": string,
  "serviceAccount": string,
  "artifactStorage": string,
  "executionTimeout": string,
  "verbose": boolean,

  // Union field execution_environment can be only one of the following:
  "defaultPool": {
    object (DefaultPool)
  },
  "privatePool": {
    object (PrivatePool)
  }
  // End of list of possible types for union field execution_environment.
}
Campi
usages[]

enum (ExecutionEnvironmentUsage)

Obbligatorio. Utilizzo quando deve essere applicata questa configurazione.
workerPool

string

Facoltativo. Il nome della risorsa di WorkerPool nel formato projects/{project}/locations/{location}/workerPools/{workerPool}. Se questo campo facoltativo non è specificato, verrà utilizzato il pool di Cloud Build predefinito.
serviceAccount

string

Facoltativo. Account di servizio Google da utilizzare per l'esecuzione. Se non specificato, viene utilizzato l'account di servizio di esecuzione del progetto (-compute@developer.gserviceaccount.com).
artifactStorage

string

Facoltativo. Località di Cloud Storage in cui archiviare gli output di esecuzione. Può essere un bucket ("gs://my-bucket") o un percorso all'interno di un bucket ("gs://my-bucket/my-dir"). Se non specificato, verrà utilizzato un bucket predefinito che si trova nella stessa regione.
executionTimeout

string (Duration format)

Facoltativo. Timeout per un'esecuzione di Cloud Build. Il formato deve essere compreso tra 10 min e 24 h in secondi. Se non specificati, viene utilizzato un timeout predefinito di 1 h.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
verbose

boolean

Facoltativo. Se il valore è true, il logging aggiuntivo verrà abilitato per le esecuzioni di Cloud Build in esecuzione in questo ambiente di esecuzione.
Campo di unione execution_environment. Dettagli dell'ambiente. execution_environment può essere solo uno dei seguenti:
defaultPool

object (DefaultPool)

Facoltativo. Usa il pool di Cloud Build predefinito.
privatePool

object (PrivatePool)

Facoltativo. Usa il pool di Cloud Build privato.

ExecutionEnvironmentUsage

Possibili utilizzi di questa configurazione.

Enum
EXECUTION_ENVIRONMENT_USAGE_UNSPECIFIED Valore predefinito. Questo valore non è utilizzato.
RENDER Da utilizzare per il rendering.
DEPLOY Da utilizzare per gli hook di deployment e deployment.
VERIFY Da utilizzare per la verifica del deployment.
PREDEPLOY Da utilizzare per l'esecuzione del job di pre-deployment.
POSTDEPLOY Da utilizzare per l'esecuzione del job post-deployment.

DefaultPool

Esecuzione con il pool Cloud Build predefinito.

Rappresentazione JSON 
{
  "serviceAccount": string,
  "artifactStorage": string
}
Campi
serviceAccount

string

Facoltativo. Account di servizio Google da utilizzare per l'esecuzione. Se non specificato, verrà utilizzato l'account di servizio di esecuzione del progetto (-compute@developer.gserviceaccount.com).
artifactStorage

string

Facoltativo. Località di Cloud Storage in cui devono essere archiviati gli output di esecuzione. Può essere un bucket ("gs://my-bucket") o un percorso all'interno di un bucket ("gs://my-bucket/my-dir"). Se non specificato, verrà utilizzato un bucket predefinito che si trova nella stessa regione.

PrivatePool

Esecuzione con un pool Cloud Build privato.

Rappresentazione JSON 
{
  "workerPool": string,
  "serviceAccount": string,
  "artifactStorage": string
}
Campi
workerPool

string

Obbligatorio. Nome della risorsa del pool di worker Cloud Build da utilizzare. Il formato è projects/{project}/locations/{location}/workerPools/{pool}.
serviceAccount

string

Facoltativo. Account di servizio Google da utilizzare per l'esecuzione. Se non specificato, verrà utilizzato l'account di servizio di esecuzione del progetto (-compute@developer.gserviceaccount.com).
artifactStorage

string

Facoltativo. Località di Cloud Storage in cui devono essere archiviati gli output di esecuzione. Può essere un bucket ("gs://my-bucket") o un percorso all'interno di un bucket ("gs://my-bucket/my-dir"). Se non specificato, verrà utilizzato un bucket predefinito che si trova nella stessa regione.

Metodi

create

 Crea un nuovo target in un progetto e una località specifici.

delete

 Elimina una singola destinazione.

get

 Recupera i dettagli di un singolo target.

getIamPolicy

 Ottieni il criterio di controllo dell'accesso per una risorsa.

list

 Elenca le destinazioni in un determinato progetto e località.

patch

 Aggiorna i parametri di un singolo target.

setIamPolicy

 Imposta il criterio di controllo dell'accesso sulla risorsa specificata.

testIamPermissions

 Restituisce le autorizzazioni di cui un chiamante dispone per la risorsa specificata.