path: root/contrib/libs/yandex-cloud-api-protos/yandex/cloud/apploadbalancer/v1/target_group_service.proto

syntax = "proto3";

package yandex.cloud.apploadbalancer.v1;

import "google/api/annotations.proto";
import "google/protobuf/field_mask.proto";

import "yandex/cloud/api/operation.proto";
import "yandex/cloud/operation/operation.proto";
import "yandex/cloud/apploadbalancer/v1/target_group.proto";
import "yandex/cloud/validation.proto";

option go_package = "github.com/yandex-cloud/go-genproto/yandex/cloud/apploadbalancer/v1;apploadbalancer";
option java_package = "yandex.cloud.api.apploadbalancer.v1";

// A set of methods for managing target groups.
service TargetGroupService {
  // Returns the specified target group.
  //
  // To get the list of all available target groups, make a [List] request.
  rpc Get(GetTargetGroupRequest) returns (TargetGroup) {
    option (google.api.http) = {get: "/apploadbalancer/v1/targetGroups/{target_group_id}"};
  }

  // Lists target groups in the specified folder.
  rpc List(ListTargetGroupsRequest) returns (ListTargetGroupsResponse) {
    option (google.api.http) = {get: "/apploadbalancer/v1/targetGroups"};
  }

  // Creates a target group in the specified folder.
  rpc Create(CreateTargetGroupRequest) returns (operation.Operation) {
    option (google.api.http) = {post: "/apploadbalancer/v1/targetGroups" body: "*"};
    option (yandex.cloud.api.operation) = {
      metadata: "CreateTargetGroupMetadata"
      response: "TargetGroup"
    };
  }

  // Updates the specified target group.
  rpc Update(UpdateTargetGroupRequest) returns (operation.Operation) {
    option (google.api.http) = {patch: "/apploadbalancer/v1/targetGroups/{target_group_id}" body: "*"};
    option (yandex.cloud.api.operation) = {
      metadata: "UpdateTargetGroupMetadata"
      response: "TargetGroup"
    };
  }

  // Deletes the specified target group.
  rpc Delete(DeleteTargetGroupRequest) returns (operation.Operation) {
    option (google.api.http) = {delete: "/apploadbalancer/v1/targetGroups/{target_group_id}"};
    option (yandex.cloud.api.operation) = {
      metadata: "DeleteTargetGroupMetadata"
      response: "google.protobuf.Empty"
    };
  }

  // Adds targets to the specified target group.
  rpc AddTargets(AddTargetsRequest) returns (operation.Operation) {
    option (google.api.http) = {post: "/apploadbalancer/v1/targetGroups/{target_group_id}:addTargets" body: "*"};
    option (yandex.cloud.api.operation) = {
      metadata: "AddTargetsMetadata"
      response: "TargetGroup"
    };
  }

  // Removes targets from the specified target group.
  rpc RemoveTargets(RemoveTargetsRequest) returns (operation.Operation) {
    option (google.api.http) = {post: "/apploadbalancer/v1/targetGroups/{target_group_id}:removeTargets" body: "*"};
    option (yandex.cloud.api.operation) = {
      metadata: "RemoveTargetsMetadata"
      response: "TargetGroup"
    };
  }

  // Lists operations for the specified target group.
  rpc ListOperations (ListTargetGroupOperationsRequest) returns (ListTargetGroupOperationsResponse) {
    option (google.api.http) = {get: "/apploadbalancer/v1/targetGroups/{target_group_id}/operations"};
  }
}

message GetTargetGroupRequest {
  // ID of the target group to return.
  //
  // To get the target group ID, make a [TargetGroupService.List] request.
  string target_group_id = 1 [(required) = true];
}

message ListTargetGroupsRequest {
  // ID of the folder to list target groups in.
  //
  // To get the folder ID, make a [yandex.cloud.resourcemanager.v1.FolderService.List] request.
  string folder_id = 1 [(required) = true];

  // The maximum number of results per page to return. If the number of available
  // results is larger than `page_size`, the service returns a [ListTargetGroupsResponse.next_page_token]
  // that can be used to get the next page of results in subsequent list requests.
  // Default value: 100.
  int64 page_size = 2 [(value) = "0-1000"];

  // Page token. To get the next page of results, set `page_token` to the
  // [ListTargetGroupsResponse.next_page_token] returned by a previous list request.
  string page_token = 3 [(length) = "<=100"];

  // A filter expression that filters target groups listed in the response.
  //
  // The expression must specify:
  // 1. The field name. Currently you can use filtering only on [TargetGroup.name] field.
  // 2. An `=` operator.
  // 3. The value in double quotes (`"`). Must be 3-63 characters long and match the regular expression `[a-z][-a-z0-9]{1,61}[a-z0-9]`.
  // Example of a filter: `name=my-target-group`.
  string filter = 4 [(length) = "<=1000"];
}

message ListTargetGroupsResponse {
  // List of target groups in the specified folder.
  repeated TargetGroup target_groups = 1;

  // Token for getting the next page of the list. If the number of results is greater than
  // the specified [ListTargetGroupsRequest.page_size], use `next_page_token` as the value
  // for the [ListTargetGroupsRequest.page_token] parameter in the next list request.
  //
  // Each subsequent page will have its own `next_page_token` to continue paging through the results.
  string next_page_token = 2;
}

message DeleteTargetGroupRequest {
  // ID of the target group to delete.
  //
  // To get the target group ID, make a [TargetGroupService.List] request.
  string target_group_id = 1 [(required) = true];
}

message DeleteTargetGroupMetadata {
  // ID of the target group that is being deleted.
  string target_group_id = 1;
}

message UpdateTargetGroupRequest {
  // ID of the target group to update.
  //
  // To get the target group ID, make a [TargetGroupService.List] request.
  string target_group_id = 1 [(required) = true];

  // Field mask that specifies which attributes of the target group should be updated.
  google.protobuf.FieldMask update_mask = 2;

  // New name for the target group.
  // The name must be unique within the folder.
  string name = 3 [(pattern) = "([a-z]([-a-z0-9]{0,61}[a-z0-9])?)?"];

  // New description of the target group.
  string description = 4 [(length) = "<=256"];

  // Target group labels as `key:value` pairs.
  // For details about the concept, see [documentation](/docs/overview/concepts/services#labels).
  //
  // Existing set of labels is completely replaced by the provided set, so if you just want
  // to add or remove a label:
  // 1. Get the current set of labels with a [TargetGroupService.Get] request.
  // 2. Add or remove a label in this set.
  // 3. Send the new set in this field.
  map<string, string> labels = 5 [(yandex.cloud.size) = "<=64", (length) = "<=63", (pattern) = "[-_./\\@0-9a-z]*", (map_key).length = "1-63", (map_key).pattern = "[a-z][-_./\\@0-9a-z]*"];

  // New list of targets in the target group.
  //
  // Existing list of targets is completely replaced by the specified list, so if you just want to add or remove
  // a target, make a [TargetGroupService.AddTargets] request or a [TargetGroupService.RemoveTargets] request.
  repeated Target targets = 6;
}

message UpdateTargetGroupMetadata {
  // ID of the target group that is being updated.
  string target_group_id = 1;
}

message CreateTargetGroupRequest {
  // ID of the folder to create a target group in.
  //
  // To get the folder ID, make a [yandex.cloud.resourcemanager.v1.FolderService.List] request.
  string folder_id = 1 [(required) = true];

  // Name of the target group.
  // The name must be unique within the folder.
  string name = 2 [(pattern) = "([a-z]([-a-z0-9]{0,61}[a-z0-9])?)?"];

  // Description of the target group.
  string description = 3 [(length) = "<=256"];

  // Target group labels as `key:value` pairs.
  // For details about the concept, see [documentation](/docs/overview/concepts/services#labels).
  map<string, string> labels = 4 [(yandex.cloud.size) = "<=64", (length) = "<=63", (pattern) = "[-_./\\@0-9a-z]*", (map_key).length = "1-63", (map_key).pattern = "[a-z][-_./\\@0-9a-z]*"];

  // List of targets in the target group.
  repeated Target targets = 5;
}

message CreateTargetGroupMetadata {
  // ID of the target group that is being created.
  string target_group_id = 1;
}

message AddTargetsRequest {
  // ID of the target group to add targets to.
  //
  // To get the target group ID, make a [TargetGroupService.List] request.
  string target_group_id = 1 [(required) = true];

  // List of targets to add to the target group.
  repeated Target targets = 2 [(size) = ">0"];
}

message AddTargetsMetadata {
  // ID of the target group that the targets are being added to.
  string target_group_id = 1;
}

message RemoveTargetsRequest {
  // ID of the target group to remove targets from.
  //
  // To get the target group ID, make a [TargetGroupService.List] request.
  string target_group_id = 1 [(required) = true];

  // List of targets to remove from the target group.
  repeated Target targets = 2 [(size) = ">0"];
}

message RemoveTargetsMetadata {
  // ID of the target group that the targets are being removed from.
  string target_group_id = 1;
}

message ListTargetGroupOperationsRequest {
  // ID of the target group to get operations for.
  //
  // To get the target group ID, use a [TargetGroupService.List] request.
  string target_group_id = 1 [(required) = true, (length) = "<=50"];

  // The maximum number of results per page that should be returned. If the number of available
  // results is larger than [page_size], the service returns a [ListTargetGroupOperationsResponse.next_page_token]
  // that can be used to get the next page of results in subsequent list requests.
  // Default value: 100.
  int64 page_size = 2 [(value) = "<=1000"];

  // Page token. To get the next page of results, set [page_token] to the
  // [ListTargetGroupOperationsResponse.next_page_token] returned by a previous list request.
  string page_token = 3 [(length) = "<=100"];
}

message ListTargetGroupOperationsResponse {
  // List of operations for the specified target group.
  repeated operation.Operation operations = 1;

  // Token for getting the next page of the list. If the number of results is greater than
  // the specified [ListTargetGroupOperationsRequest.page_size], use `next_page_token` as the value
  // for the [ListTargetGroupOperationsRequest.page_token] parameter in the next list request.
  //
  // Each subsequent page will have its own `next_page_token` to continue paging through the results.
  string next_page_token = 2;
}