Contact UsGet started

Container Registry API, gRPC: RegistryService.UpdateIpPermission

Written by
Updated at October 17, 2024

Update ip permissions for the specified registry.

gRPC request

rpc UpdateIpPermission (UpdateIpPermissionRequest) returns (operation.Operation)

UpdateIpPermissionRequest

{
  "registryId": "string",
  "ipPermissionDeltas": [
    {
      "action": "IpPermissionAction",
      "ipPermission": {
        "action": "Action",
        "ip": "string"
      }
    }
  ]
}

Field

Description

registryId

string

Required field. ID of the registry for which ip permissions are being updated.

ipPermissionDeltas[]

IpPermissionDelta

Updates to IP permissions.

IpPermissionDelta

Field

Description

action

enum IpPermissionAction

Required field. The action that is being performed on an ip permission.

  • IP_PERMISSION_ACTION_UNSPECIFIED
  • ADD: Addition of an ip permission.
  • REMOVE: Removal of an ip permission.

ipPermission

IpPermission

Required field. Ip permission.

IpPermission

Field

Description

action

enum Action

  • ACTION_UNSPECIFIED
  • PULL
  • PUSH

ip

string

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "registryId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Empty"
  // 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.

createdAt

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

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

modifiedAt

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

UpdateIpPermissionMetadata

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

google.protobuf.Empty

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.

UpdateIpPermissionMetadata

Field

Description

registryId

string

ID of the registry that ip permission is being updated.
Previous
SetIpPermission
Next
Overview