Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Yandex Cloud Marketplace License Manager, gRPC: LockService.Ensure

Written by
Updated at August 8, 2025

Checks if the she specified subscription is already locked to the specified resource.
If it is not locked, locks the subscription to the resource.

gRPC request

rpc Ensure (EnsureLockRequest) returns (operation.Operation)

EnsureLockRequest

{
  "instance_id": "string",
  "resource_id": "string"
}

Field

Description

instance_id

string

Required field. ID of the subscription instance.

resource_id

string

Required field. ID of the resource to which the subscription will be locked.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "lock_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "instance_id": "string",
    "resource_id": "string",
    "start_time": "google.protobuf.Timestamp",
    "end_time": "google.protobuf.Timestamp",
    "created_at": "google.protobuf.Timestamp",
    "updated_at": "google.protobuf.Timestamp",
    "state": "State",
    "template_id": "string",
    "external_instance": {
      "name": "string",
      "properties": "map<string, string>",
      // Includes only one of the fields `subscription`, `license`
      "subscription": {
        "subscription_id": "string",
        "license_id": "string",
        "activation_key": "string"
      },
      "license": {
        "license_id": "string",
        "payload": "bytes"
      }
      // end of the list of possible fields
    }
  }
  // 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

EnsureLockMetadata

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

Lock

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.

EnsureLockMetadata

Field

Description

lock_id

string

ID of the subscription lock.

Lock

Field

Description

id

string

ID of the subscription lock.

instance_id

string

ID of the subscription instance.

resource_id

string

ID of the resource.

start_time

google.protobuf.Timestamp

Timestamp of the start of the subscription lock.

end_time

google.protobuf.Timestamp

Timestamp of the end of the subscription lock.

created_at

google.protobuf.Timestamp

Creation timestamp.

updated_at

google.protobuf.Timestamp

Update timestamp.

state

enum State

Subscription lock state.

  • STATE_UNSPECIFIED
  • UNLOCKED: Subscription unlocked.
  • LOCKED: Subscription locked to the resource.
  • DELETED: Subscription lock deleted.

template_id

string

ID of the subscription template.

external_instance

ExternalInstance

External subscription instance (optional), for usage convenience propagated
from parent subscription instance.

ExternalInstance

ExternalInstance attachment to external service subscription.

Field

Description

name

string

Optional external subscription name.

properties

object (map<string, string>)

Mapping of vendor defined properties in key, value format.

subscription

ExternalSubscription

Includes only one of the fields subscription, license.

license

ExternalLicense

Includes only one of the fields subscription, license.

ExternalSubscription

Field

Description

subscription_id

string

External subscription id.

license_id

string

Optional: paired license id for external subscription.

activation_key

string

Optional: default activation key for external subscription.

ExternalLicense

Field

Description

license_id

string

External license bound to subscription instance.

payload

bytes

License (vendor specific) payload.
Previous
Create
Next
Delete