Package google.cloud.observability.v1

Índice

Observabilidade

Serviço que descreve manipuladores para recursos

CreateTraceScope

rpc CreateTraceScope(CreateTraceScopeRequest) returns (TraceScope)

Crie um novo TraceScope.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • observability.traceScopes.create

Para mais informações, consulte a documentação do IAM.
DeleteTraceScope

rpc DeleteTraceScope(DeleteTraceScopeRequest) returns (Empty)

Exclui um TraceScope.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • observability.traceScopes.delete

Para mais informações, consulte a documentação do IAM.
GetBucket

rpc GetBucket(GetBucketRequest) returns (Bucket)

Receba o recurso de bucket.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • observability.buckets.get

Para mais informações, consulte a documentação do IAM.
GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

Receber um conjunto de dados.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • observability.datasets.get

Para mais informações, consulte a documentação do IAM.
GetScope

rpc GetScope(GetScopeRequest) returns (Scope)

Recebe detalhes de um único escopo.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • observability.scopes.get

Para mais informações, consulte a documentação do IAM.
GetSettings

rpc GetSettings(GetSettingsRequest) returns (Settings)

Receber configurações

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • observability.settings.get

Para mais informações, consulte a documentação do IAM.
GetTraceScope

rpc GetTraceScope(GetTraceScopeRequest) returns (TraceScope)

Receba o recurso TraceScope.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • observability.traceScopes.get

Para mais informações, consulte a documentação do IAM.
GetView

rpc GetView(GetViewRequest) returns (View)

Receba uma visualização.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • observability.views.get

Para mais informações, consulte a documentação do IAM.
ListBuckets

rpc ListBuckets(ListBucketsRequest) returns (ListBucketsResponse)

Listar buckets de um projeto em um local específico.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • observability.buckets.list

Para mais informações, consulte a documentação do IAM.
ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

Lista os conjuntos de dados de um bucket.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • observability.datasets.list

Para mais informações, consulte a documentação do IAM.
ListTraceScopes

rpc ListTraceScopes(ListTraceScopesRequest) returns (ListTraceScopesResponse)

Lista os TraceScopes de um projeto em um local específico.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • observability.traceScopes.list

Para mais informações, consulte a documentação do IAM.
ListViews

rpc ListViews(ListViewsRequest) returns (ListViewsResponse)

Lista as visualizações de um conjunto de dados.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • observability.views.list

Para mais informações, consulte a documentação do IAM.
UpdateScope

rpc UpdateScope(UpdateScopeRequest) returns (Scope)

Atualiza os parâmetros de um único escopo.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • observability.scopes.update

Para mais informações, consulte a documentação do IAM.
UpdateSettings

rpc UpdateSettings(UpdateSettingsRequest) returns (Operation)

Atualizar configurações

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • observability.settings.update

Para mais informações, consulte a documentação do IAM.
UpdateTraceScope

rpc UpdateTraceScope(UpdateTraceScopeRequest) returns (TraceScope)

Atualiza um TraceScope.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • observability.traceScopes.update

Para mais informações, consulte a documentação do IAM.

Bucket

Configuração de bucket para armazenar dados de observabilidade.

Campos
name

string

Identificador. Nome do bloco. O formato é:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
display_name

string

Opcional. É um nome de exibição fácil de usar.
description

string

Opcional. Descrição do bucket.
create_time

Timestamp

Apenas saída. Crie um carimbo de data/hora.
update_time

Timestamp

Apenas saída. Carimbo de data/hora da atualização.
delete_time

Timestamp

Apenas saída. Exclua a marcação de tempo.
purge_time

Timestamp

Apenas saída. Carimbo de data/hora em que o bucket no estado de exclusão reversível é removido permanentemente.
cmek_settings

CmekSettings

Opcional. Configurações para configurar a CMEK em um bucket.

CmekSettings

Configurações para configurar a CMEK para um bucket.

Campos
kms_key

string

Opcional. O nome do recurso da chave do Cloud KMS configurada. O formato é:

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]

Exemplo:

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key
kms_key_version

string

Apenas saída. O nome do recurso CryptoKeyVersion para a chave do Cloud KMS configurada. O formato é:

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]

Exemplo:

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1

Esse campo somente leitura é usado para transmitir a CryptoKeyVersion específica configurada do kms_key. Ele é preenchido quando as configurações de CMEK são vinculadas a uma única versão de chave.
service_account_id

string

Apenas saída. A conta de serviço usada para acessar a chave.

CreateLinkRequest

Solicitação para criar um link.

Campos
parent

string

Obrigatório. Nome do conjunto de dados que contém este link. O formato é:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]

CreateTraceScopeRequest

Solicitação para criar um TraceScope.

Campos
parent

string

Obrigatório. O nome completo do recurso do local em que o escopo de rastreamento deve ser criado

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Exemplo:

projects/my-project/locations/global
trace_scope_id

string

Obrigatório. Um identificador atribuído pelo cliente para o escopo do rastreamento.
trace_scope

TraceScope

Obrigatório. O novo escopo de rastreamento.

Conjunto de dados

Um conjunto de dados é uma coleção de dados com uma configuração específica. Um conjunto de dados pode ser apoiado por várias tabelas. Um bucket pode ter vários conjuntos de dados.

Campos
name

string

Identificador. Nome do conjunto de dados. O formato é:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
display_name

string

Opcional. É um nome de exibição fácil de usar.
description

string

Opcional. Descrição do conjunto de dados.
create_time

Timestamp

Apenas saída. Criar carimbo de data/hora.
delete_time

Timestamp

Apenas saída. Exclua a marcação de tempo.
purge_time

Timestamp

Apenas saída. Carimbo de data/hora em que o conjunto de dados no estado de exclusão reversível é limpo.

DeleteLinkRequest

Solicitação para excluir um link.

Campos
name

string

Obrigatório. Nome do link a ser excluído. O formato é:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]

DeleteTraceScopeRequest

Solicitação para excluir um TraceScope.

Campos
name

string

Obrigatório. O nome completo do recurso do escopo de rastreamento a ser excluído:

projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID]

Exemplo:

projects/my-project/locations/global/traceScopes/my-trace-scope

GetBucketRequest

Solicitação para receber um bucket.

Campos
name

string

Obrigatório. Nome do bucket a ser recuperado. O formato é:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]

GetDatasetRequest

Solicitação para receber um conjunto de dados.

Campos
name

string

Obrigatório. Nome do conjunto de dados a ser recuperado. O formato é:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]

GetLinkRequest

Solicitação para receber um link.

Campos
name

string

Obrigatório. Nome do link a ser recuperado. O formato é:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]

GetScopeRequest

Mensagem para receber um escopo.

Campos
name

string

Obrigatório. Nome do recurso. O formato é:

projects/{project}/locations/{location}/scopes/{scope}

O campo {location} precisa ser definido como global. O campo {scope} precisa ser definido como _Default.

GetSettingsRequest

Solicitação para receber configurações.

Campos
name

string

Obrigatório. Nome das configurações a serem recuperadas.

Formato do nome:

"projects/[PROJECT_ID]/locations/[LOCATION]/settings"
"folders/[FOLDER_ID]/locations/[LOCATION]/settings"
"organizations/[ORGANIZATION_ID]/locations/[LOCATION]/settings"

GetTraceScopeRequest

Solicitação para receber um TraceScope.

Campos
name

string

Obrigatório. O nome do recurso do escopo do rastreamento:

projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID]

Exemplo:

projects/my-project/locations/global/traceScopes/my-trace-scope

GetViewRequest

Solicitação para receber uma visualização.

Campos
name

string

Obrigatório. Nome da visualização a ser recuperada. O formato é:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/views/[VIEW_ID]

ListBucketsRequest

Solicitação para listar buckets.

Campos
parent

string

Obrigatório. O pai, que é proprietário dessa coleção de buckets. O formato é:

projects/[PROJECT_ID]/locations/[LOCATION]
page_size

int32

Opcional. O número máximo de buckets a serem retornados. Se não for especificado, no máximo 100 intervalos serão retornados. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.
page_token

string

Opcional. Um token de página recebido de uma chamada ListBuckets anterior. Forneça isso para recuperar a página subsequente.
show_deleted

bool

Opcional. Se for "true", a resposta vai incluir buckets excluídos.

ListBucketsResponse

Resposta para listar intervalos.

Campos
buckets[]

Bucket

Opcional. A lista de intervalos.
next_page_token

string

Opcional. Um token que pode ser enviado como page_token para recuperar a próxima página. Quando esse campo é omitido, não há páginas subsequentes.

ListDatasetsRequest

Solicitação para listar conjuntos de dados.

Campos
parent

string

Obrigatório. O bucket principal que tem essa coleção de conjuntos de dados. O formato é:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
page_size

int32

Opcional. O número máximo de conjuntos de dados a serem retornados. Se não for especificado, no máximo 100 conjuntos de dados serão retornados. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.
page_token

string

Opcional. Um token de página recebido de uma chamada ListDatasets anterior. Forneça isso para recuperar a página subsequente.
show_deleted

bool

Opcional. Se for "true", a resposta vai incluir conjuntos de dados excluídos.

ListDatasetsResponse

Resposta para listar conjuntos de dados.

Campos
datasets[]

Dataset

A lista de conjuntos de dados.
next_page_token

string

Um token que pode ser enviado como page_token para recuperar a próxima página. Quando esse campo é omitido, não há páginas subsequentes.

ListLinksRequest

Solicitação de links de fichas.

Campos
parent

string

Obrigatório. O conjunto de dados principal que tem essa coleção de links. O formato é:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
page_size

int32

Opcional. O número máximo de links a serem retornados. Se não for especificado, no máximo 100 links serão retornados. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.
page_token

string

Opcional. Um token de página recebido de uma chamada ListLinks anterior. Forneça isso para recuperar a página subsequente.

ListLinksResponse

Resposta para listar links.

Campos
next_page_token

string

Opcional. Um token que pode ser enviado como page_token para recuperar a próxima página. Quando esse campo é omitido, não há páginas subsequentes.

ListTraceScopesRequest

Solicitação para listar TraceScopes.

Campos
parent

string

Obrigatório. O nome completo do recurso do local para procurar escopos de rastreamento:

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Exemplo:

projects/my-project/locations/global
page_size

int32

Opcional. O número máximo de resultados a serem retornados dessa solicitação.

Valores não positivos são ignorados. A presença de next_page_token na resposta indica que mais resultados podem estar disponíveis.
page_token

string

Opcional. Se estiver presente, recupere o próximo lote de resultados da chamada anterior para esse método. page_token precisa ser o valor de next_page_token da resposta anterior. Os valores de outros parâmetros do método precisam ser idênticos aos da chamada anterior.

ListTraceScopesResponse

Resposta para listar TraceScopes.

Campos
trace_scopes[]

TraceScope

Opcional. Uma lista de escopos de rastreamento.
next_page_token

string

Opcional. Se houver mais resultados do que os que aparecem nesta resposta, next_page_token será incluído. Para receber o próximo conjunto de resultados, chame o mesmo método novamente usando o valor de next_page_token como page_token.

ListViewsRequest

Solicitação para visualizações de fichas.

Campos
parent

string

Obrigatório. Conjunto de dados cujas visualizações serão listadas. O formato é:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
page_size

int32

Opcional. O número máximo de visualizações a serem retornadas. Se não for especificado, no máximo 100 visualizações serão retornadas. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.
page_token

string

Opcional. Um token de página recebido de uma chamada ListViews anterior. Forneça isso para recuperar a página subsequente.

ListViewsResponse

Resposta para listar visualizações.

Campos
views[]

View

A lista de visualizações.
next_page_token

string

Opcional. Um token que pode ser enviado como page_token para recuperar a próxima página. Quando esse campo é omitido, não há páginas subsequentes.

OperationMetadata

Representa os metadados da operação de longa duração.

Campos
create_time

Timestamp

Somente saída: a hora em que a operação foi criada.
end_time

Timestamp

Somente saída: a hora em que a operação terminou de ser executada.
target

string

Apenas saída. Caminho do recurso definido pelo servidor para o destino da operação.
verb

string

Apenas saída. Nome do verbo executado pela operação.
status_message

string

Apenas saída. Status legível da operação, caso haja um.
requested_cancellation

bool

Apenas saída. Identifica se o usuário solicitou o cancelamento da operação. As operações que foram canceladas têm o valor [Operation.error][] com um google.rpc.Status.code de 1, correspondente a Code.CANCELLED.
api_version

string

Apenas saída. Versão da API usada para iniciar a operação.

Escopo

Mensagem que descreve o objeto Scope

Campos
name

string

Identificador. Nome do recurso. O formato é:

projects/{project}/locations/{location}/scopes/{scope}

O campo {location} precisa ser definido como global. O campo {scope} precisa ser definido como _Default.
update_time

Timestamp

Apenas saída. Carimbo de data/hora da atualização. Observação: o carimbo de data/hora da atualização para o escopo padrão fica inicialmente indefinido.
log_scope

string

Obrigatório. O nome completo do recurso de LogScope. Exemplo:

//logging.googleapis.com/projects/myproject/locations/global/logScopes/my-log-scope
trace_scope

string

Obrigatório. O nome do recurso do TraceScope. Exemplo:

projects/myproject/locations/global/traceScopes/my-trace-scope

Configurações

Descreve as configurações associadas a um projeto, uma organização ou uma pasta.

Campos
name

string

Identificador. O nome do recurso das configurações.
default_storage_location

string

Opcional. O local que deve ser usado quando os recursos regionais são provisionados pelo Google Cloud.
service_account_id

string

Apenas saída. A conta de serviço do contêiner de recursos especificado, como projeto ou pasta. Isso será usado pelo Cloud Observability para realizar ações no projeto do contêiner, como acessar chaves do KMS ou criar links. Sempre a mesma conta de serviço por contêiner de recursos, independente da região.
kms_key_name

string

Opcional. O nome do recurso da chave do Cloud KMS configurada.

Formato do nome da chave do KMS:

"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]"

Exemplo:

"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"

TraceScope

Um escopo de trace é uma coleção de recursos cujos traces são consultados juntos.

Campos
name

string

Identificador. O nome do recurso do escopo de rastreamento.

Exemplo:

projects/my-project/locations/global/traceScopes/my-trace-scope
resource_names[]

string

Obrigatório. Nomes dos projetos incluídos neste escopo de rastreamento.

  • projects/[PROJECT_ID]

Um escopo de rastreamento pode incluir no máximo 20 projetos.
description

string

Opcional. Descreve o escopo do trace.

O tamanho máximo da descrição é de 8.000 caracteres.
create_time

Timestamp

Apenas saída. O carimbo de data/hora de criação do escopo do trace.
update_time

Timestamp

Apenas saída. O último carimbo de data/hora de atualização do escopo do rastreamento.

UpdateLinkRequest

Solicitação para atualizar um link.

Campos
update_mask

FieldMask

Opcional. Lista de campos a serem atualizados.

UpdateScopeRequest

Mensagem para atualizar um escopo.

Campos
update_mask

FieldMask

Opcional. A máscara de campo é usada para especificar os campos a serem substituídos no recurso Scope pela atualização. Os campos especificados em update_mask são relativos ao recurso, não à solicitação completa. Um campo é substituído quando está na máscara. Se o usuário não fornecer uma máscara, todos os campos presentes na solicitação serão substituídos.
scope

Scope

Obrigatório. O recurso que está sendo atualizado.

UpdateSettingsRequest

Solicitação para atualizar as configurações.

Campos
settings

Settings

Obrigatório. As configurações a serem atualizadas.

O campo "name" das configurações é usado para identificar o recurso a ser atualizado.
update_mask

FieldMask

Opcional. A máscara de campo que especifica quais campos das configurações serão atualizados.

UpdateTraceScopeRequest

Solicitação para atualizar um TraceScope.

Campos
trace_scope

TraceScope

Obrigatório. O escopo de rastreamento atualizado.
update_mask

FieldMask

Opcional. Lista de campos a serem atualizados.

Ver

Uma visualização corresponde a uma representação somente leitura de um subconjunto dos dados em um conjunto de dados.

Campos
name

string

Identificador. Nome da visualização. O formato é:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/views/[VIEW_ID]
display_name

string

Opcional. É um nome de exibição fácil de usar.
description

string

Opcional. Descrição da visualização.
create_time

Timestamp

Apenas saída. Criar carimbo de data/hora.
update_time

Timestamp

Apenas saída. Carimbo de data/hora da atualização.