Package google.cloud.observability.v1

Índice

Observabilidad

Servicio que describe los controladores de los 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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso parent:

  • observability.traceScopes.create

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

DeleteTraceScope

rpc DeleteTraceScope(DeleteTraceScopeRequest) returns (Empty)

Elimina 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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • observability.traceScopes.delete

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

GetScope

rpc GetScope(GetScopeRequest) returns (Scope)

Obtiene los detalles de un solo Scope.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • observability.scopes.get

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • observability.traceScopes.get

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

ListTraceScopes

rpc ListTraceScopes(ListTraceScopesRequest) returns (ListTraceScopesResponse)

Lista los TraceScopes de un proyecto en una ubicación concreta.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso parent:

  • observability.traceScopes.list

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

UpdateScope

rpc UpdateScope(UpdateScopeRequest) returns (Scope)

Actualiza los parámetros de un solo Scope.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • observability.scopes.update

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso name:

  • observability.traceScopes.update

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

CreateTraceScopeRequest

Solicitud para crear un TraceScope.

Campos
parent

string

Obligatorio. Nombre de recurso completo de la ubicación en la que se debe crear el ámbito de la traza.

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Por ejemplo:

projects/my-project/locations/global
trace_scope_id

string

Obligatorio. Identificador asignado por el cliente del ámbito del rastreo.

trace_scope

TraceScope

Obligatorio. El nuevo ámbito de la traza.

DeleteTraceScopeRequest

Solicitud para eliminar un TraceScope.

Campos
name

string

Obligatorio. Nombre completo del recurso del ámbito de la traza que se va a eliminar:

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

Por ejemplo:

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

GetScopeRequest

Mensaje para obtener un ámbito.

Campos
name

string

Obligatorio. Nombre del recurso. El formato es el siguiente:

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

El campo {location} debe tener el valor global. El campo {scope} debe tener el valor _Default.

GetTraceScopeRequest

Solicitud para obtener un TraceScope.

Campos
name

string

Obligatorio. Nombre de recurso del ámbito de la traza:

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 de recurso completo de la ubicación en la que se buscarán los ámbitos de la traza:

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Por ejemplo:

projects/my-project/locations/global
page_size

int32

Opcional. Número máximo de resultados que se devolverán en esta solicitud.

Se ignoran los valores no positivos. La presencia de next_page_token en la respuesta indica que puede haber más resultados disponibles.

page_token

string

Opcional. Si está presente, se recuperará 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 los demás parámetros del método deben ser idénticos a los de la llamada anterior.

ListTraceScopesResponse

Respuesta para enumerar TraceScopes.

Campos
trace_scopes[]

TraceScope

Opcional. Lista de ámbitos 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 usando 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

Solo de salida. Hora en la que se creó la operación.

end_time

Timestamp

Solo de salida. Hora a la que ha terminado de ejecutarse la operación.

target

string

Solo de salida. Ruta de recurso definida por el servidor del destino de la operación.

verb

string

Solo de salida. Nombre del verbo ejecutado por la operación.

status_message

string

Solo de salida. Estado de la operación legible por humanos, si procede.

requested_cancellation

bool

Solo de salida. Identifica si el usuario ha solicitado la cancelación de la operación. Las operaciones que se han cancelado correctamente tienen el valor [Operation.error][] con un google.rpc.Status.code de 1, que corresponde a Code.CANCELLED.

api_version

string

Solo de salida. Versión de la API usada para iniciar la operación.

Ámbito

Mensaje que describe el objeto Scope

Campos
name

string

Identificador. Nombre del recurso. El formato es el siguiente:

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

El campo {location} debe tener el valor global. El campo {scope} debe tener el valor _Default.

update_time

Timestamp

Solo de salida. Marca de tiempo de la actualización. Nota: La marca de tiempo de actualización del ámbito predeterminado no se define inicialmente.

log_scope

string

Obligatorio. Nombre completo del recurso LogScope. Por ejemplo:

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

string

Obligatorio. Nombre de recurso del TraceScope. Por ejemplo:

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

TraceScope

Un ámbito de rastreo es un conjunto de recursos cuyas trazas se consultan conjuntamente.

Campos
name

string

Identificador. Nombre de recurso del ámbito de la traza.

Por ejemplo:

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

string

Obligatorio. Nombres de los proyectos incluidos en este ámbito de seguimiento.

  • projects/[PROJECT_ID]

Un ámbito de rastreo puede incluir un máximo de 20 proyectos.

description

string

Opcional. Describe este ámbito de traza.

La longitud máxima de la descripción es de 8000 caracteres.

create_time

Timestamp

Solo de salida. Marca de tiempo de creación del ámbito del rastreo.

update_time

Timestamp

Solo de salida. Marca de tiempo de la última actualización del ámbito del rastreo.

UpdateScopeRequest

Mensaje para actualizar un Scope.

Campos
update_mask

FieldMask

Opcional. La máscara de campo se usa para especificar los campos que se van a sobrescribir en el recurso Scope mediante la actualización. Los campos especificados en update_mask son relativos al recurso, no a la solicitud completa. Un campo se sobrescribe cuando está en la máscara. Si el usuario no proporciona una máscara, se sobrescribirán todos los campos presentes en la solicitud.

scope

Scope

Obligatorio. El recurso que se está actualizando.

UpdateTraceScopeRequest

Solicitud para actualizar un TraceScope.

Campos
trace_scope

TraceScope

Obligatorio. El ámbito de la traza actualizado.

update_mask

FieldMask

Opcional. Lista de campos que se van a actualizar.