Package google.cloud.observability.v1

Índice

Observabilidade

Serviço que descreve controladores para recursos

CreateTraceScope

rpc CreateTraceScope(CreateTraceScopeRequest) returns (TraceScope)

Crie um novo TraceScope.

Âmbitos de autorização

Requer o seguinte âmbito do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • observability.traceScopes.create

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

rpc DeleteTraceScope(DeleteTraceScopeRequest) returns (Empty)

Elimine um TraceScope.

Âmbitos de autorização

Requer o seguinte âmbito do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • observability.traceScopes.delete

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

rpc GetScope(GetScopeRequest) returns (Scope)

Obtém detalhes de um único âmbito.

Âmbitos de autorização

Requer o seguinte âmbito do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • observability.scopes.get

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

rpc GetTraceScope(GetTraceScopeRequest) returns (TraceScope)

Obtenha o recurso TraceScope.

Âmbitos de autorização

Requer o seguinte âmbito do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • observability.traceScopes.get

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

rpc ListTraceScopes(ListTraceScopesRequest) returns (ListTraceScopesResponse)

Apresenta TraceScopes de um projeto numa localização específica.

Âmbitos de autorização

Requer o seguinte âmbito do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • observability.traceScopes.list

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

rpc UpdateScope(UpdateScopeRequest) returns (Scope)

Atualiza os parâmetros de um único âmbito.

Âmbitos de autorização

Requer o seguinte âmbito do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • observability.scopes.update

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

rpc UpdateTraceScope(UpdateTraceScopeRequest) returns (TraceScope)

Atualize um TraceScope.

Âmbitos de autorização

Requer o seguinte âmbito do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • observability.traceScopes.update

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

CreateTraceScopeRequest

Pedido de criação de um TraceScope.

Campos
parent

string

Obrigatório. O nome do recurso completo da localização onde o âmbito do rastreio deve ser criado

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Por exemplo:

projects/my-project/locations/global
trace_scope_id

string

Obrigatório. Um identificador atribuído pelo cliente para o âmbito do rastreio.
trace_scope

TraceScope

Obrigatório. O novo âmbito do rastreio.

DeleteTraceScopeRequest

Pedido de eliminação de um TraceScope.

Campos
name

string

Obrigatório. O nome completo do recurso do âmbito do rastreio a eliminar:

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

Por exemplo:

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

GetScopeRequest

Mensagem para obter um âmbito.

Campos
name

string

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

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

O campo {location} tem de estar definido como global. O campo {scope} tem de estar definido como _Default.

GetTraceScopeRequest

Pedido de obtenção de um TraceScope.

Campos
name

string

Obrigatório. O nome do recurso do âmbito do rastreio:

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

Por exemplo:

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

ListTraceScopesRequest

Pedido para listar TraceScopes.

Campos
parent

string

Obrigatório. O nome completo do recurso da localização para procurar âmbitos de rastreio:

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Por exemplo:

projects/my-project/locations/global
page_size

int32

Opcional. O número máximo de resultados a devolver deste pedido.

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

string

Opcional. Se estiver presente, obtenha o lote seguinte de resultados da chamada anterior a este método. page_token tem de ser o valor de next_page_token da resposta anterior. Os valores de outros parâmetros do método devem ser idênticos aos da chamada anterior.

ListTraceScopesResponse

Resposta para listar TraceScopes.

Campos
trace_scopes[]

TraceScope

Opcional. Uma lista de âmbitos de rastreio.
next_page_token

string

Opcional. Se puderem existir mais resultados do que os que aparecem nesta resposta, é incluído next_page_token. Para obter o conjunto seguinte de resultados, chame novamente o mesmo método usando o valor de next_page_token como page_token.

OperationMetadata

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

Campos
create_time

Timestamp

Apenas saída. A hora em que a operação foi criada.
end_time

Timestamp

Apenas saída. A hora em que a operação terminou.
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. Estado da operação legível por humanos, se existir.
requested_cancellation

bool

Apenas saída. Identifica se o utilizador solicitou o cancelamento da operação. As operações que foram canceladas com êxito 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.

Âmbito

Mensagem que descreve o objeto Scope

Campos
name

string

Identificador. Nome do recurso. O formato é:

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

O campo {location} tem de estar definido como global. O campo {scope} tem de estar definido como _Default.
update_time

Timestamp

Apenas saída. Data/hora da atualização. Nota: a indicação de tempo de atualização do âmbito predefinido não está inicialmente definida.
log_scope

string

Obrigatório. O nome completo do recurso do LogScope. Por exemplo:

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

string

Obrigatório. O nome do recurso de TraceScope. Por exemplo:

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

TraceScope

Um âmbito de rastreio é uma coleção de recursos cujos rastreios são consultados em conjunto.

Campos
name

string

Identificador. O nome do recurso do âmbito do rastreio.

Por exemplo:

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

string

Obrigatório. Nomes dos projetos incluídos neste âmbito de rastreio.

  • projects/[PROJECT_ID]

Um âmbito de rastreio pode incluir um máximo de 20 projetos.
description

string

Opcional. Descreve este âmbito do rastreio.

O comprimento máximo da descrição é de 8000 carateres.
create_time

Timestamp

Apenas saída. A data/hora de criação do âmbito do rastreio.
update_time

Timestamp

Apenas saída. A data/hora da última atualização do âmbito do rastreio.

UpdateScopeRequest

Mensagem para atualizar um âmbito.

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 e não ao pedido completo. Um campo é substituído quando está na máscara. Se o utilizador não fornecer uma máscara, todos os campos presentes no pedido são substituídos.
scope

Scope

Obrigatório. O recurso que está a ser atualizado.

UpdateTraceScopeRequest

Pedido de atualização de um TraceScope.

Campos
trace_scope

TraceScope

Obrigatório. O âmbito do rastreio atualizado.
update_mask

FieldMask

Opcional. A lista de campos a atualizar.