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.
GetBucket

rpc GetBucket(GetBucketRequest) returns (Bucket)

Obtiene el recurso del bucket.

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.buckets.get

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

rpc GetDataset(GetDatasetRequest) returns (Dataset)

Obtén un conjunto de datos

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.datasets.get

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.
GetSettings

rpc GetSettings(GetSettingsRequest) returns (Settings)

Obtener configuración

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.settings.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.
GetView

rpc GetView(GetViewRequest) returns (View)

Obtener una vista

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.views.get

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

rpc ListBuckets(ListBucketsRequest) returns (ListBucketsResponse)

Enumera los buckets de un proyecto en una ubicación en particular.

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.buckets.list

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

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

Enumera los conjuntos de datos de un bucket.

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.datasets.list

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.
ListViews

rpc ListViews(ListViewsRequest) returns (ListViewsResponse)

Enumera las vistas de un conjunto de datos.

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.views.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.
UpdateSettings

rpc UpdateSettings(UpdateSettingsRequest) returns (Operation)

Actualizar configuración

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.settings.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.

Bucket

Es la configuración del bucket para almacenar datos de observabilidad.

Campos
name

string

Es el identificador. Nombre del bucket. El formato es el siguiente:

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

string

Es opcional. Es el nombre visible fácil de usar.
description

string

Es opcional. Es la descripción del bucket.
create_time

Timestamp

Solo salida. Marca de tiempo de creación.
update_time

Timestamp

Solo salida. Es la marca de tiempo de la actualización.
delete_time

Timestamp

Solo salida. Borra la marca de tiempo.
purge_time

Timestamp

Solo salida. Es la marca de tiempo del momento en que se borró el bucket en estado de eliminación no definitiva.
cmek_settings

CmekSettings

Es opcional. Es la configuración para configurar la CMEK en un bucket.

CmekSettings

Es la configuración para configurar la CMEK de un bucket.

Campos
kms_key

string

Es opcional. Nombre del recurso de la clave de Cloud KMS configurada. El formato es el siguiente:

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

Por ejemplo:

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

string

Solo salida. Es el nombre del recurso CryptoKeyVersion para la clave de Cloud KMS configurada. El formato es el siguiente:

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

Por ejemplo:

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

Este campo de solo lectura se usa para transmitir la CryptoKeyVersion específica configurada del kms_key que se configuró. Se propaga cuando la configuración de CMEK está vinculada a una sola versión de clave.
service_account_id

string

Solo salida. Es la cuenta de servicio que se usa para acceder a la clave.

CreateLinkRequest

Es la solicitud para crear un vínculo.

Campos
parent

string

Obligatorio. Nombre del conjunto de datos que contiene este vínculo. El formato es el siguiente:

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

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 de seguimiento

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.

Conjunto de datos

Un conjunto de datos es una colección de datos que tiene una configuración específica. Un conjunto de datos puede estar respaldado por varias tablas. Un bucket puede tener varios conjuntos de datos.

Campos
name

string

Es el identificador. Nombre del conjunto de datos. El formato es el siguiente:

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

string

Es opcional. Es el nombre visible fácil de usar.
description

string

Es opcional. Es la descripción del conjunto de datos.
create_time

Timestamp

Solo salida. Marca de tiempo de creación.
delete_time

Timestamp

Solo salida. Borra la marca de tiempo.
purge_time

Timestamp

Solo salida. Es la marca de tiempo en la que se borga el conjunto de datos en estado de borrado no definitivo.

DeleteLinkRequest

Es la solicitud para borrar un vínculo.

Campos
name

string

Obligatorio. Es el nombre del vínculo que se borrará. El formato es el siguiente:

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

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

GetBucketRequest

Es una solicitud para obtener un bucket.

Campos
name

string

Obligatorio. Nombre del bucket que se recuperará. El formato es el siguiente:

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

GetDatasetRequest

Es una solicitud para obtener un conjunto de datos.

Campos
name

string

Obligatorio. Nombre del conjunto de datos que se recuperará. El formato es el siguiente:

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

GetLinkRequest

Es una solicitud para obtener un vínculo.

Campos
name

string

Obligatorio. Es el nombre del vínculo que se recuperará. El formato es el siguiente:

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

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.

GetSettingsRequest

Es una solicitud para obtener la configuración.

Campos
name

string

Obligatorio. Nombre de la configuración que se recuperará.

Formato del nombre:

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

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

GetViewRequest

Es una solicitud para obtener una vista.

Campos
name

string

Obligatorio. Nombre de la vista que se recuperará. El formato es el siguiente:

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

ListBucketsRequest

Es una solicitud para enumerar buckets.

Campos
parent

string

Obligatorio. Es el elemento superior, que es propietario de esta colección de buckets. El formato es el siguiente:

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

int32

Es opcional. Es la cantidad máxima de buckets que se devolverán. Si no se especifica, se devolverán, como máximo, 100 buckets. Como el valor máximo es 1,000, los valores superiores se convertirán a 1,000.
page_token

string

Es opcional. Un token de página, recibido desde una llamada ListBuckets anterior. Proporciona esto para recuperar la página siguiente.
show_deleted

bool

Es opcional. Si es verdadero, la respuesta incluirá los buckets borrados.

ListBucketsResponse

Es la respuesta para la enumeración de buckets.

Campos
buckets[]

Bucket

Es opcional. Es la lista de buckets.
next_page_token

string

Es opcional. Es un token que se puede enviar como page_token para recuperar la página siguiente. Cuando se omite este campo, no hay páginas siguientes.

ListDatasetsRequest

Es una solicitud para enumerar conjuntos de datos.

Campos
parent

string

Obligatorio. Es el bucket principal que posee esta colección de conjuntos de datos. El formato es el siguiente:

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

int32

Es opcional. Es la cantidad máxima de conjuntos de datos que se devolverán. Si no se especifica, se devolverán, como máximo, 100 conjuntos de datos. Como el valor máximo es 1,000, los valores superiores se convertirán a 1,000.
page_token

string

Es opcional. Un token de página, recibido desde una llamada ListDatasets anterior. Proporciona esto para recuperar la página siguiente.
show_deleted

bool

Es opcional. Si es verdadero, la respuesta incluirá los conjuntos de datos borrados.

ListDatasetsResponse

Es la respuesta para enumerar conjuntos de datos.

Campos
datasets[]

Dataset

Es la lista de conjuntos de datos.
next_page_token

string

Es un token que se puede enviar como page_token para recuperar la página siguiente. Cuando se omite este campo, no hay páginas siguientes.

ListLinksRequest

Es una solicitud de vínculos de la ficha.

Campos
parent

string

Obligatorio. Es el conjunto de datos principal que posee esta colección de vínculos. El formato es el siguiente:

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

int32

Es opcional. Es la cantidad máxima de vínculos que se devolverán. Si no se especifica, se devolverán, como máximo, 100 vínculos. Como el valor máximo es 1,000, los valores superiores se convertirán a 1,000.
page_token

string

Es opcional. Un token de página, recibido desde una llamada ListLinks anterior. Proporciona esto para recuperar la página siguiente.

ListLinksResponse

Es la respuesta para enumerar vínculos.

Campos
next_page_token

string

Es opcional. Es un token que se puede enviar como page_token para recuperar la página siguiente. Cuando se omite este campo, no hay páginas siguientes.

ListTraceScopesRequest

Solicitud para enumerar TraceScopes.

Campos
parent

string

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

projects/[PROJECT_ID]/locations/[LOCATION_ID]

Por ejemplo:

projects/my-project/locations/global
page_size

int32

Es 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

Es 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 los demás 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

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

string

Es 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.

ListViewsRequest

Es una solicitud para enumerar vistas.

Campos
parent

string

Obligatorio. Es el conjunto de datos cuyas vistas se enumerarán. El formato es el siguiente:

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

int32

Es opcional. Es la cantidad máxima de vistas que se devolverán. Si no se especifica, se devolverán, como máximo, 100 vistas. Como el valor máximo es 1,000, los valores superiores se convertirán a 1,000.
page_token

string

Es opcional. Un token de página, recibido desde una llamada ListViews anterior. Proporciona esto para recuperar la página siguiente.

ListViewsResponse

Es la respuesta para enumerar las vistas.

Campos
views[]

View

Es la lista de vistas.
next_page_token

string

Es opcional. Es un token que se puede enviar como page_token para recuperar la página siguiente. Cuando se omite este campo, no hay páginas siguientes.

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

Configuración

Describe la configuración asociada a un proyecto, una organización o una carpeta.

Campos
name

string

Es el identificador. Es el nombre del recurso de la configuración.
default_storage_location

string

Es opcional. Es la ubicación que se debe usar cuando Google Cloud aprovisiona recursos regionales.
service_account_id

string

Solo salida. Es la cuenta de servicio del contenedor de recursos determinado, como un proyecto o una carpeta. Cloud Observability usará este proyecto para realizar acciones en el proyecto del contenedor, como acceder a claves de KMS o crear vínculos. Siempre es la misma cuenta de servicio por contenedor de recursos, independientemente de la región.
kms_key_name

string

Es opcional. Nombre del recurso de la clave de Cloud KMS configurada.

Formato del nombre de la clave de KMS:

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

Por ejemplo:

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

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 permiso de seguimiento.

  • projects/[PROJECT_ID]

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

string

Es 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.

UpdateLinkRequest

Es una solicitud para actualizar un vínculo.

Campos
update_mask

FieldMask

Es opcional. La lista de campos que se deben actualizar.

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.

UpdateSettingsRequest

Es una solicitud para actualizar la configuración.

Campos
settings

Settings

Obligatorio. Es la configuración que se actualizará.

El campo name de la configuración se usa para identificar el recurso que se actualizará.
update_mask

FieldMask

Es opcional. Es la máscara de campo que especifica qué campos de la configuración se deben actualizar.

UpdateTraceScopeRequest

Es la solicitud para actualizar un TraceScope.

Campos
trace_scope

TraceScope

Obligatorio. Es el permiso de registro actualizado.
update_mask

FieldMask

Es opcional. La lista de campos que se deben actualizar.

Ver

Una vista corresponde a una representación de solo lectura de un subconjunto de los datos de un conjunto de datos.

Campos
name

string

Es el identificador. Nombre de la vista. El formato es el siguiente:

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

string

Es opcional. Es el nombre visible fácil de usar.
description

string

Es opcional. Es la descripción de la vista.
create_time

Timestamp

Solo salida. Marca de tiempo de creación.
update_time

Timestamp

Solo salida. Es la marca de tiempo de la actualización.