Contact UsGet started

DataSphere API v2, gRPC: CommunityService.SetRestrictions

Written by
Updated at November 26, 2024

Set community restrictions.

gRPC request

rpc SetRestrictions (SetCommunityRestrictionsRequest) returns (operation.Operation)

SetCommunityRestrictionsRequest

{
  "community_id": "string",
  "restrictions": [
    {
      "name": "string",
      "bool_value": [
        "bool"
      ],
      "long_value": [
        "int64"
      ],
      "string_value": [
        "string"
      ]
    }
  ]
}

Field

Description

community_id

string

Required field. ID of the community.

restrictions[]

Restriction

List of restrictions to set.

Restriction

Field

Description

name

string

Name of restriction.

bool_value[]

bool

List of boolean restriction values. Empty if value type is not boolean.

long_value[]

int64

List of long restriction values. Empty if value type is not long.

string_value[]

string

List of string restriction values. Empty if value type is not string.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "restrictions": [
      {
        "name": "string",
        "bool_value": [
          "bool"
        ],
        "long_value": [
          "int64"
        ],
        "string_value": [
          "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.

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

google.protobuf.Any

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

RestrictionsResponse

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.

RestrictionsResponse

Field

Description

restrictions[]

Restriction

List of restrictions.

Restriction

Field

Description

name

string

Name of restriction.

bool_value[]

bool

List of boolean restriction values. Empty if value type is not boolean.

long_value[]

int64

List of long restriction values. Empty if value type is not long.

string_value[]

string

List of string restriction values. Empty if value type is not string.
Previous
GetRestrictions
Next
Overview