Contact UsGet started

IoT Core Service, gRPC: RegistryService.Update

Written by
Updated at December 17, 2024

Updates the specified registry.

gRPC request

rpc Update (UpdateRegistryRequest) returns (operation.Operation)

UpdateRegistryRequest

{
  "registry_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "log_options": {
    "disabled": "bool",
    // Includes only one of the fields `log_group_id`, `folder_id`
    "log_group_id": "string",
    "folder_id": "string",
    // end of the list of possible fields
    "min_level": "Level"
  }
}

Field

Description

registry_id

string

Required field. ID of the registry to update.

To get a registry ID make a RegistryService.List request.

update_mask

google.protobuf.FieldMask

Field mask that specifies which fields of the registry are going to be updated.

name

string

Name of the registry. The name must be unique within the folder.

description

string

Description of the registry.

labels

object (map<string, string>)

Resource labels as key:value pairs.

Existing set of labels is completely replaced by the provided set.

log_options

LogOptions

Options for logging registry events

LogOptions

Field

Description

disabled

bool

Is logging from registry disabled.

log_group_id

string

Entry should be written to log group resolved by ID.

Includes only one of the fields log_group_id, folder_id.

Log entries destination.

folder_id

string

Entry should be written to default log group for specified folder.

Includes only one of the fields log_group_id, folder_id.

Log entries destination.

min_level

enum Level

Minimum log entry level.

See LogLevel.Level for details.

  • LEVEL_UNSPECIFIED: Default log level.

    Equivalent to not specifying log level at all.

  • TRACE: Trace log level.

    Possible use case: verbose logging of some business logic.

  • DEBUG: Debug log level.

    Possible use case: debugging special cases in application logic.

  • INFO: Info log level.

    Mostly used for information messages.

  • WARN: Warn log level.

    May be used to alert about significant events.

  • ERROR: Error log level.

    May be used to alert about errors in infrastructure, logic, etc.

  • FATAL: Fatal log level.

    May be used to alert about unrecoverable failures and events.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "registry_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "status": "Status",
    "log_group_id": "string",
    "log_options": {
      "disabled": "bool",
      // Includes only one of the fields `log_group_id`, `folder_id`
      "log_group_id": "string",
      "folder_id": "string",
      // end of the list of possible fields
      "min_level": "Level"
    }
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateRegistryMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Registry

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

UpdateRegistryMetadata

Field

Description

registry_id

string

ID of the registry that is being updated.

Registry

A registry. For more information, see Registry.

Field

Description

id

string

ID of the registry.

folder_id

string

ID of the folder that the registry belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp.

name

string

Name of the registry. The name is unique within the folder.

description

string

Description of the registry. 0-256 characters long.

labels

object (map<string, string>)

Resource labels as key:value pairs. Maximum of 64 per resource.

status

enum Status

Status of the registry.

  • STATUS_UNSPECIFIED
  • CREATING: Registry is being created.
  • ACTIVE: Registry is ready to use.
  • DELETING: Registry is being deleted.
  • DISABLED: Registry is disabled.

log_group_id

string

ID of the logs group for the specified registry.

log_options

LogOptions

Options for logging registry events

LogOptions

Field

Description

disabled

bool

Is logging from registry disabled.

log_group_id

string

Entry should be written to log group resolved by ID.

Includes only one of the fields log_group_id, folder_id.

Log entries destination.

folder_id

string

Entry should be written to default log group for specified folder.

Includes only one of the fields log_group_id, folder_id.

Log entries destination.

min_level

enum Level

Minimum log entry level.

See LogLevel.Level for details.

  • LEVEL_UNSPECIFIED: Default log level.

    Equivalent to not specifying log level at all.

  • TRACE: Trace log level.

    Possible use case: verbose logging of some business logic.

  • DEBUG: Debug log level.

    Possible use case: debugging special cases in application logic.

  • INFO: Info log level.

    Mostly used for information messages.

  • WARN: Warn log level.

    May be used to alert about significant events.

  • ERROR: Error log level.

    May be used to alert about errors in infrastructure, logic, etc.

  • FATAL: Fatal log level.

    May be used to alert about unrecoverable failures and events.
Previous
Create
Next
Delete