Package google.cloud.resourcesettings.v1alpha1

Índice

ResourceSettingsService

Es una interfaz para interactuar con la configuración de recursos y los valores de configuración en toda la jerarquía de recursos.

Los servicios pueden mostrar una serie de parámetros de configuración para que los usuarios controlen el comportamiento de sus recursos. Los valores de configuración que se aplican en un recurso de Cloud determinado se evalúan de forma jerárquica y los heredan todos los elementos secundarios de ese recurso.

Para todas las solicitudes, devuelve un google.rpc.Status con google.rpc.Code.PERMISSION_DENIED si falla la verificación de IAM o si el recurso parent no está en una organización de Cloud. Para todas las solicitudes, devuelve un google.rpc.Status con google.rpc.Code.INVALID_ARGUMENT si la solicitud tiene un formato incorrecto.

Nota: En todos los parámetros de configuración de la etapa alfa, el parámetro de configuración no existe en ningún recurso de las organizaciones de Cloud que no estén en la versión alfa.

CreateSettingValue

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

Crea un valor de configuración.

Devuelve un google.rpc.Status con google.rpc.Code.NOT_FOUND si el parámetro de configuración no existe. Devuelve un google.rpc.Status con google.rpc.Code.ALREADY_EXISTS si el valor de configuración ya existe en el recurso de Cloud determinado. Devuelve un google.rpc.Status con google.rpc.Code.FAILED_PRECONDITION si el parámetro de configuración se marca como de solo lectura.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.
DeleteSettingValue

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

Borra el valor de un parámetro de configuración. Si el valor del parámetro de configuración no existe, la operación no hace nada.

Devuelve un google.rpc.Status con google.rpc.Code.NOT_FOUND si el parámetro de configuración o su valor no existen. El valor de configuración no existirá si una llamada anterior a DeleteSetting para el valor de configuración ya devolvió un código de éxito. Devuelve un google.rpc.Status con google.rpc.Code.FAILED_PRECONDITION si el parámetro de configuración se marca como de solo lectura.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.
GetSettingValue

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

Obtiene el valor de un parámetro de configuración.

Devuelve un google.rpc.Status con google.rpc.Code.NOT_FOUND si no existe el valor de configuración.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.
ListSettings

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

Enumera todos los parámetros de configuración disponibles en el recurso de Cloud parent.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.
LookupEffectiveSettingValue

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

Calcula el valor de configuración efectivo de un parámetro de configuración en el recurso de Cloud parent. El valor de configuración efectivo es el valor de configuración calculado en un recurso de Cloud y se evalúa como una de las siguientes opciones en el orden indicado (se usa la siguiente opción si no existe la anterior):

  1. el valor de configuración en el recurso determinado
  2. El valor del parámetro de configuración en el ancestro más cercano del recurso determinado
  3. El valor predeterminado del parámetro de configuración
  4. Un valor de configuración vacío, definido como un SettingValue con todos los campos sin configurar

Devuelve un google.rpc.Status con google.rpc.Code.NOT_FOUND si el parámetro de configuración no existe.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.
SearchSettingValues

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

Busca todos los valores de configuración que existen en el recurso parent. Los valores de configuración no se limitan a los de un parámetro de configuración en particular.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.
UpdateSettingValue

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

Actualiza el valor de un parámetro de configuración.

Devuelve un google.rpc.Status con google.rpc.Code.NOT_FOUND si el parámetro de configuración o su valor no existen. Devuelve un google.rpc.Status con google.rpc.Code.FAILED_PRECONDITION si el parámetro de configuración se marca como de solo lectura. Devuelve un google.rpc.Status con google.rpc.Code.ABORTED si la ETag proporcionada en la solicitud no coincide con la ETag persistente del valor de configuración.

Nota: El valor de configuración proporcionado sobrescribirá por completo todos los campos.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.

CreateSettingValueRequest

Es la solicitud de CreateSettingValue.

Campos
setting_value

SettingValue

Es el valor de configuración que se creará. Consulta SettingValue para conocer los requisitos de los campos.

La autorización requiere el siguiente permiso IAM en el recurso especificado settingValue:

  • resourcesettings.settingvalues.create

DeleteSettingValueRequest

Es la solicitud de DeleteSettingValue.

Campos
name

string

Nombre del valor de configuración que se borrará. Consulta SettingValue para conocer los requisitos de nombres.

La autorización requiere el siguiente permiso IAM en el recurso especificado name:

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

Es una marca que permite borrar el valor de un parámetro de configuración de read_only. ADVERTENCIA: Úsala bajo tu propia responsabilidad. Borrar el valor de un parámetro de configuración de solo lectura es una acción irreversible (es decir, no se puede volver a crear).

GetSettingValueRequest

Es la solicitud de GetSettingValue.

Campos
name

string

Es el nombre del valor de configuración que se obtendrá. Consulta SettingValue para conocer los requisitos de nombres.

La autorización requiere el siguiente permiso IAM en el recurso especificado name:

  • resourcesettings.settingvalues.get

ListSettingsRequest

Es la solicitud de ListSettings.

Campos
parent

string

Es el recurso de Cloud que es principal del parámetro de configuración. Debe tener una de las siguientes formas:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

La autorización requiere el siguiente permiso IAM en el recurso especificado parent:

  • resourcesettings.settings.list
page_size

int32

No se utiliza. Es el tamaño de la página que se devolverá.
page_token

string

No se utiliza. Es un token de página que se usa para recuperar la página siguiente.

ListSettingsResponse

Es la respuesta de ListSettings.

Campos
settings[]

Setting

Es una lista de parámetros de configuración que están disponibles en el recurso de Cloud especificado.
next_page_token

string

No se utiliza. Es un token de página que se usa para recuperar la página siguiente.

LookupEffectiveSettingValueRequest

Es la solicitud de LookupEffectiveSettingValue.

Campos
parent

string

Es el parámetro de configuración para el que se evaluará un valor efectivo. Consulta Setting para conocer los requisitos de nombres.

La autorización requiere el siguiente permiso IAM en el recurso especificado parent:

  • resourcesettings.settingvalues.get

SearchSettingValuesRequest

Es la solicitud de SearchSettingValues.

Campos
parent

string

Es el recurso de Cloud que es principal del parámetro de configuración. Debe tener una de las siguientes formas:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

La autorización requiere el siguiente permiso IAM en el recurso especificado parent:

  • resourcesettings.settingvalues.list
page_size

int32

No se utiliza. Es el tamaño de la página que se devolverá.
page_token

string

No se utiliza. Es un token de página que se usa para recuperar la página siguiente.

SearchSettingValuesResponse

Es la respuesta de SearchSettingValues.

Campos
setting_values[]

SettingValue

Son todos los valores de configuración que existen en el recurso de Cloud especificado.
next_page_token

string

No se utiliza. Es un token de página que se usa para recuperar la página siguiente.

Configuración

Es el esquema para establecer valores. En un recurso de Cloud determinado, un parámetro de configuración puede ser superior a un valor de configuración como máximo.

Campos
name

string

Es el nombre del recurso del parámetro de configuración. Debe tener una de las siguientes formas:

  • projects/{project_number}/settings/{setting_name}
  • folders/{folder_id}/settings/{setting_name}
  • organizations/{organization_id}/settings/{setting_name}

Por ejemplo, "/projects/123/settings/gcp-enableMyFeature"
display_name

string

Es el nombre legible de este parámetro de configuración.
description

string

Es una descripción detallada de lo que hace este parámetro de configuración.
read_only

bool

Es una marca que indica que los valores de este parámetro de configuración no se pueden modificar (consulta la documentación del parámetro de configuración específico para obtener actualizaciones y motivos). Sin embargo, se puede borrar con DeleteSettingValue si DeleteSettingValueRequest.ignore_read_only se establece como verdadero. Usar esta marca se considera como una confirmación de que no se puede volver a crear el valor del parámetro de configuración. Consulta DeleteSettingValueRequest.ignore_read_only para obtener más información.
data_type

DataType

Es el tipo de datos de este parámetro de configuración.
default_value

Value

Es el valor que recibe LookupEffectiveSettingValue si no se establece explícitamente ningún valor de configuración.

Nota: No todos los parámetros de configuración tienen un valor predeterminado.

DataType

Es el tipo de datos para establecer los valores de este parámetro de configuración. Consulta Value para obtener más detalles sobre los tipos de datos disponibles.

Enumeraciones
DATA_TYPE_UNSPECIFIED Tipo de datos sin especificar.
BOOLEAN Es un parámetro de configuración booleano.
STRING Es un parámetro de configuración de cadena.
STRING_SET Es un parámetro de configuración de conjunto de cadenas.

SettingValue

Es la instancia de un parámetro de configuración. Cada valor de configuración está asociado a su configuración correspondiente.

Campos
name

string

Es el nombre del recurso del valor de configuración. Debe tener una de las siguientes formas:

  • projects/{project_number}/settings/{setting_name}/value
  • folders/{folder_id}/settings/{setting_name}/value
  • organizations/{organization_id}/settings/{setting_name}/value

Por ejemplo, "/projects/123/settings/gcp-enableMyFeature/value"
value

Value

Es el valor del parámetro de configuración. El tipo de datos de Value siempre debe ser coherente con el tipo de datos definido por el parámetro de configuración principal.
etag

string

Es una huella dactilar que se usa para la simultaneidad optimista. Consulta UpdateSettingValue para obtener más información.
read_only

bool

Solo salida. Es una marca que indica que no se puede modificar el valor de este parámetro de configuración. Sin embargo, se puede borrar con DeleteSettingValue si DeleteSettingValueRequest.ignore_read_only se establece como verdadero. Usar esta marca se considera como una confirmación de que no se puede volver a crear el valor del parámetro de configuración. Esta marca se hereda de su parámetro de configuración principal y se incluye por conveniencia. Consulta Setting.read_only para obtener más información.
update_time

Timestamp

Solo salida. Es la marca de tiempo que indica cuándo se actualizó por última vez el valor del parámetro de configuración.

UpdateSettingValueRequest

Es la solicitud de UpdateSettingValue.

Campos
setting_value

SettingValue

Es el valor del parámetro de configuración que se actualizará. Consulta SettingValue para conocer los requisitos de los campos.

La autorización requiere el siguiente permiso IAM en el recurso especificado settingValue:

  • resourcesettings.settingvalues.update

Valor

Son los datos de un valor de configuración.

Campos
Campo de unión value. Selecciona el tipo de datos y el valor asociado. Las direcciones (value) solo pueden ser una de las siguientes opciones:
boolean_value

bool

Define este valor como un valor booleano.
string_value

string

Define este valor como un valor de cadena.
string_set_value

StringSet

Define este valor como un StringSet.

StringSet

Es un valor de conjunto de cadenas que puede contener un conjunto de cadenas. La longitud máxima de cada cadena es de 60 caracteres, y puede haber un máximo de 50 cadenas en el conjunto de cadenas.

Campos
values[]

string

Las cadenas del conjunto