Package google.cloud.observability.v1

Índice

Observabilidad

Controladores de descripción de servicios para recursos

CreateTraceScope

rpc CreateTraceScope(CreateTraceScopeRequest) returns (TraceScope)

Crea un nuevo TraceScope.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • observability.traceScopes.create

Para obtener más información, consulta la documentación de IAM.
DeleteTraceScope

rpc DeleteTraceScope(DeleteTraceScopeRequest) returns (Empty)

Borra un TraceScope.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • observability.traceScopes.delete

Para obtener más información, consulta la documentación de IAM.
GetScope

rpc GetScope(GetScopeRequest) returns (Scope)

Obtiene detalles de un solo permiso.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • observability.scopes.get

Para obtener más información, consulta la documentación de IAM.
GetTraceScope

rpc GetTraceScope(GetTraceScopeRequest) returns (TraceScope)

Obtiene el recurso TraceScope.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • observability.traceScopes.get

Para obtener más información, consulta la documentación de IAM.
ListTraceScopes

rpc ListTraceScopes(ListTraceScopesRequest) returns (ListTraceScopesResponse)

Enumera los objetos TraceScope de un proyecto en una ubicación determinada.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • observability.traceScopes.list

Para obtener más información, consulta la documentación de IAM.
UpdateScope

rpc UpdateScope(UpdateScopeRequest) returns (Scope)

Actualiza los parámetros de un solo permiso.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • observability.scopes.update

Para obtener más información, consulta la documentación de IAM.
UpdateTraceScope

rpc UpdateTraceScope(UpdateTraceScopeRequest) returns (TraceScope)

Actualiza un TraceScope.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • observability.traceScopes.update

Para obtener más información, consulta la documentación de IAM.

CreateTraceScopeRequest

Es la solicitud para crear un TraceScope.

Campos
parent

string

Obligatorio. Nombre completo del recurso de la ubicación en la que se debe crear el alcance del registro

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Por ejemplo:

projects/my-project/locations/global
trace_scope_id

string

Obligatorio. Es un identificador asignado por el cliente para el alcance del registro.
trace_scope

TraceScope

Obligatorio. Es el nuevo alcance de seguimiento.

DeleteTraceScopeRequest

Es la solicitud para borrar un TraceScope.

Campos
name

string

Obligatorio. Nombre completo del recurso del alcance del registro que se borrará:

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

Por ejemplo:

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

GetScopeRequest

Es el mensaje para obtener un permiso.

Campos
name

string

Es obligatorio. Indica el nombre del recurso. El formato es el siguiente:

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

El campo {location} debe establecerse en global. El campo {scope} debe establecerse en _Default.

GetTraceScopeRequest

Es una solicitud para obtener un TraceScope.

Campos
name

string

Obligatorio. Nombre del recurso del alcance de seguimiento:

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

Por ejemplo:

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

ListTraceScopesRequest

Solicitud para enumerar TraceScopes.

Campos
parent

string

Obligatorio. Nombre completo del recurso de la ubicación en la que se buscarán los ámbitos de seguimiento:

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Por ejemplo:

projects/my-project/locations/global
page_size

int32

Opcional. Es la cantidad máxima de resultados que se devolverán con esta solicitud.

Se ignoran los valores no positivos. La presencia de next_page_token en la respuesta indica que es posible que haya más resultados disponibles.
page_token

string

Opcional. Si está presente, recupera el siguiente lote de resultados de la llamada anterior a este método. page_token debe ser el valor de next_page_token de la respuesta anterior. Los valores de otros parámetros del método deben ser idénticos a los de la llamada anterior.

ListTraceScopesResponse

Es la respuesta para enumerar TraceScopes.

Campos
trace_scopes[]

TraceScope

Opcional. Es una lista de los permisos de seguimiento.
next_page_token

string

Opcional. Si es posible que haya más resultados de los que aparecen en esta respuesta, se incluye next_page_token. Para obtener el siguiente conjunto de resultados, vuelve a llamar al mismo método con el valor de next_page_token como page_token.

OperationMetadata

Representa los metadatos de la operación de larga duración.

Campos
create_time

Timestamp

Es solo de salida. Indica la hora a la que se creó la operación.
end_time

Timestamp

Es solo de salida. Indica la hora a la que finalizó la operación.
target

string

Es solo de salida. Indica la ruta de acceso al recurso definida por el servidor para el destino de la operación.
verb

string

Es solo de salida. Indica el nombre de la acción que ejecuta la operación.
status_message

string

Es solo de salida. Indica el estado legible por humanos de la operación, si corresponde.
requested_cancellation

bool

Es solo de salida. Identifica si el usuario solicitó la cancelación de la operación. Las operaciones que se cancelaron de forma correcta tienen el valor [Operation.error][] con un google.rpc.Status.code de 1, que corresponde a Code.CANCELLED.
api_version

string

Es solo de salida. Indica la versión de la API que se usó para iniciar la operación.

Permiso

Mensaje que describe el objeto de permiso

Campos
name

string

Es el identificador. Indica el nombre del recurso. El formato es el siguiente:

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

El campo {location} debe establecerse en global. El campo {scope} debe establecerse en _Default.
update_time

Timestamp

Es solo de salida. Es la marca de tiempo de la actualización. Nota: Al principio, no se establece la marca de tiempo de actualización para el permiso predeterminado.
log_scope

string

Es obligatorio. Es el nombre completo del recurso LogScope. Por ejemplo:

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

string

Obligatorio. Es el nombre del recurso TraceScope. Por ejemplo:

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

TraceScope

Un permiso de seguimiento es una colección de recursos cuyas pistas se consultan juntas.

Campos
name

string

Es el identificador. Es el nombre del recurso del alcance del registro.

Por ejemplo:

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

string

Obligatorio. Son los nombres de los proyectos que se incluyen en este alcance de seguimiento.

  • projects/[PROJECT_ID]

Un alcance de seguimiento puede incluir un máximo de 20 proyectos.
description

string

Opcional. Describe este alcance de seguimiento.

La longitud máxima de la descripción es de 8,000 caracteres.
create_time

Timestamp

Solo salida. Es la marca de tiempo de creación del alcance del registro.
update_time

Timestamp

Solo salida. Es la marca de tiempo de la última actualización del alcance del registro.

UpdateScopeRequest

Es el mensaje para actualizar un permiso.

Campos
update_mask

FieldMask

Es opcional. La máscara de campo se usa para especificar los campos que la actualización reemplazará en el recurso del permiso. Los campos especificados en update_mask se relacionan con el recurso, no con la solicitud completa. Un campo se reemplaza si está en la máscara. Si el usuario no proporciona una máscara, se reemplazan todos los campos presentes en la solicitud.
scope

Scope

Es obligatorio. Indica que el recurso se está actualizando.

UpdateTraceScopeRequest

Es una solicitud para actualizar un TraceScope.

Campos
trace_scope

TraceScope

Obligatorio. Es el alcance del registro actualizado.
update_mask

FieldMask

Opcional. La lista de campos que se deben actualizar.