Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Yandex Cloud Marketplace License Manager for SaaS, gRPC: LockService.Ensure

Written by
Updated at October 17, 2024

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

{
  "instanceToken": "string",
  "resourceId": "string"
}

Field

Description

instanceToken

string

Required field. Signed JWT token which contains information about subscription.

resourceId

string

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

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "lockId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "instanceId": "string",
    "resourceId": "string",
    "startTime": "google.protobuf.Timestamp",
    "endTime": "google.protobuf.Timestamp",
    "createdAt": "google.protobuf.Timestamp",
    "updatedAt": "google.protobuf.Timestamp",
    "state": "State",
    "templateId": "string"
  }
  // 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

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

lockId

string

ID of the subscription lock.

Lock

Field

Description

id

string

ID of the subscription lock.

instanceId

string

ID of the subscription instance.

resourceId

string

ID of the resource.

startTime

google.protobuf.Timestamp

Timestamp of the start of the subscription lock.

endTime

google.protobuf.Timestamp

Timestamp of the end of the subscription lock.

createdAt

google.protobuf.Timestamp

Creation timestamp.

updatedAt

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.

templateId

string

ID of the subscription template.
Previous
Overview
Next
Get