feat(hostsets): Classify all proto fields
This commit is contained in:
1 parent
8fa3e8dee0
commit
d51ce41db8
11 files changed
+483
-285
No files matched your search
@@ -14,10 +14,10 @@ import "controller/custom_options/v1/options.proto";
|
||||
// HostSet is a collection of Hosts created and managed by a Host Catalog
|
||||
message HostSet {
|
||||
// Output only. The ID of the Host Set.
|
||||
string id = 10;
|
||||
string id = 10; // @gotags: `class:"public"`
|
||||
|
||||
// The Host Catalog of which this Host Set is a part.
|
||||
string host_catalog_id = 20 [json_name="host_catalog_id"];
|
||||
string host_catalog_id = 20 [json_name="host_catalog_id"]; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. Scope information for this resource.
|
||||
resources.scopes.v1.ScopeInfo scope = 30;
|
||||
@@ -26,26 +26,26 @@ message HostSet {
|
||||
resources.plugins.v1.PluginInfo plugin = 35;
|
||||
|
||||
// Optional name for identification purposes.
|
||||
google.protobuf.StringValue name = 40 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"name" that: "name"}];
|
||||
google.protobuf.StringValue name = 40 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"name" that: "name"}]; // @gotags: `class:"public"`
|
||||
|
||||
// Optional user-set description for identification purposes.
|
||||
google.protobuf.StringValue description = 50 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"description" that: "description"}];
|
||||
google.protobuf.StringValue description = 50 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"description" that: "description"}]; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. The time this resource was created.
|
||||
google.protobuf.Timestamp created_time = 60 [json_name="created_time"];
|
||||
google.protobuf.Timestamp created_time = 60 [json_name="created_time"]; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. The time this resource was last updated.
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
|
||||
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"]; // @gotags: `class:"public"`
|
||||
|
||||
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
|
||||
// The mutation will fail if the version does not match the latest known good version.
|
||||
uint32 version = 80;
|
||||
uint32 version = 80; // @gotags: `class:"public"`
|
||||
|
||||
// The type of the Host Set.
|
||||
string type = 90;
|
||||
string type = 90; // @gotags: `class:"public"`
|
||||
|
||||
// Output only. A list of Hosts in this Host Set.
|
||||
repeated string host_ids = 100 [json_name="host_ids"];
|
||||
repeated string host_ids = 100 [json_name="host_ids"]; // @gotags: `class:"public"`
|
||||
|
||||
// multiple possible endpoints for a host. Preferences are specified by
|
||||
// "cidr:<valid IPv4/6 CIDR>" or "dns:<globbed name>", specifying which IP
|
||||
@@ -53,7 +53,7 @@ message HostSet {
|
||||
// preferred. If no preferences are specified, a value will be chosen from
|
||||
// among all avialable values using a built-in priority order. May not be
|
||||
// valid for all plugin types.
|
||||
repeated string preferred_endpoints = 101 [json_name="preferred_endpoints", (custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"preferred_endpoints" that: "PreferredEndpoints"}];
|
||||
repeated string preferred_endpoints = 101 [json_name="preferred_endpoints", (custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"preferred_endpoints" that: "PreferredEndpoints"}]; // @gotags: `class:"public"`
|
||||
|
||||
// An interger number of seconds indicating the amount of time that should
|
||||
// elapse between syncs of the host set. The interval will be applied to the
|
||||
@@ -61,11 +61,13 @@ message HostSet {
|
||||
// disable syncing for that host set; setting to zero will cause the set to
|
||||
// use Boundary's default. The default may change between releases. May not
|
||||
// be valid for all plugin types.
|
||||
google.protobuf.Int32Value sync_interval_seconds = 102 [json_name="sync_interval_seconds", (custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"sync_interval_seconds" that: "SyncIntervalSeconds"}];
|
||||
google.protobuf.Int32Value sync_interval_seconds = 102 [json_name="sync_interval_seconds", (custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"sync_interval_seconds" that: "SyncIntervalSeconds"}]; // @gotags: `class:"public"`
|
||||
|
||||
// The attributes that are applicable for the specific Host Set type.
|
||||
google.protobuf.Struct attributes = 110 [(custom_options.v1.generate_sdk_option) = true];
|
||||
oneof attrs {
|
||||
// The attributes that are applicable for the specific Host Set type.
|
||||
google.protobuf.Struct attributes = 110 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.subtype) = "default"];
|
||||
}
|
||||
|
||||
// Output only. The available actions on this resource for this user.
|
||||
repeated string authorized_actions = 300 [json_name="authorized_actions"];
|
||||
repeated string authorized_actions = 300 [json_name="authorized_actions"]; // @gotags: `class:"public"`
|
||||
}
|
||||
@@ -8,6 +8,9 @@ import "protoc-gen-openapiv2/options/annotations.proto";
|
||||
import "google/api/annotations.proto";
|
||||
import "google/protobuf/field_mask.proto";
|
||||
import "controller/api/resources/hostsets/v1/host_set.proto";
|
||||
import "controller/custom_options/v1/options.proto";
|
||||
|
||||
option (custom_options.v1.domain) = "host";
|
||||
|
||||
service HostSetService {
|
||||
// GetHostSet returns a stored Host Set if present. The provided request
|
||||
@@ -135,7 +138,7 @@ service HostSetService {
|
||||
}
|
||||
|
||||
message GetHostSetRequest {
|
||||
string id = 1;
|
||||
string id = 1; // @gotags: `class:"public"`
|
||||
}
|
||||
|
||||
message GetHostSetResponse {
|
||||
@@ -143,8 +146,8 @@ message GetHostSetResponse {
|
||||
}
|
||||
|
||||
message ListHostSetsRequest {
|
||||
string host_catalog_id = 1 [json_name="host_catalog_id"];
|
||||
string filter = 30 [json_name="filter"];
|
||||
string host_catalog_id = 1 [json_name="host_catalog_id"]; // @gotags: `class:"public"`
|
||||
string filter = 30 [json_name="filter"]; // @gotags: `class:"public"`
|
||||
}
|
||||
|
||||
message ListHostSetsResponse {
|
||||
@@ -156,12 +159,12 @@ message CreateHostSetRequest {
|
||||
}
|
||||
|
||||
message CreateHostSetResponse {
|
||||
string uri = 1;
|
||||
string uri = 1; // @gotags: `class:"public"`
|
||||
api.resources.hostsets.v1.HostSet item = 2;
|
||||
}
|
||||
|
||||
message UpdateHostSetRequest {
|
||||
string id = 1;
|
||||
string id = 1; // @gotags: `class:"public"`
|
||||
api.resources.hostsets.v1.HostSet item = 2;
|
||||
google.protobuf.FieldMask update_mask = 3 [json_name="update_mask"];
|
||||
}
|
||||
@@ -171,19 +174,19 @@ message UpdateHostSetResponse {
|
||||
}
|
||||
|
||||
message DeleteHostSetRequest {
|
||||
string id = 1;
|
||||
string id = 1; // @gotags: `class:"public"`
|
||||
}
|
||||
|
||||
message DeleteHostSetResponse {}
|
||||
|
||||
message AddHostSetHostsRequest {
|
||||
string id = 1;
|
||||
string id = 1; // @gotags: `class:"public"`
|
||||
// Version is used to ensure this resource has not changed.
|
||||
// The mutation will fail if the version does not match the latest known good version.
|
||||
uint32 version = 2;
|
||||
uint32 version = 2; // @gotags: `class:"public"`
|
||||
|
||||
// A list of Host IDs which will be added to this Host Set. Each Host referenced here must be a child of the same Host Catalog of which this Host Set is a child.
|
||||
repeated string host_ids = 3 [json_name="host_ids"];
|
||||
repeated string host_ids = 3 [json_name="host_ids"]; // @gotags: `class:"public"`
|
||||
}
|
||||
|
||||
message AddHostSetHostsResponse {
|
||||
@@ -191,13 +194,13 @@ message AddHostSetHostsResponse {
|
||||
}
|
||||
|
||||
message SetHostSetHostsRequest {
|
||||
string id = 1;
|
||||
string id = 1; // @gotags: `class:"public"`
|
||||
// Version is used to ensure this resource has not changed.
|
||||
// The mutation will fail if the version does not match the latest known good version.
|
||||
uint32 version = 2;
|
||||
uint32 version = 2; // @gotags: `class:"public"`
|
||||
|
||||
// A list of Host IDs which will be set on this Host Set. Each Host referenced here must be a child of the same Host Catalog of which this Host Set is a child.
|
||||
repeated string host_ids = 3 [json_name="host_ids"];
|
||||
repeated string host_ids = 3 [json_name="host_ids"]; // @gotags: `class:"public"`
|
||||
}
|
||||
|
||||
message SetHostSetHostsResponse {
|
||||
@@ -205,13 +208,13 @@ message SetHostSetHostsResponse {
|
||||
}
|
||||
|
||||
message RemoveHostSetHostsRequest {
|
||||
string id = 1;
|
||||
string id = 1; // @gotags: `class:"public"`
|
||||
// Version is used to ensure this resource has not changed.
|
||||
// The mutation will fail if the version does not match the latest known good version.
|
||||
uint32 version = 2;
|
||||
uint32 version = 2; // @gotags: `class:"public"`
|
||||
|
||||
// A list of Host IDs which will be removed from this Host Set.
|
||||
repeated string host_ids = 3 [json_name="host_ids"];
|
||||
repeated string host_ids = 3 [json_name="host_ids"]; // @gotags: `class:"public"`
|
||||
}
|
||||
|
||||
message RemoveHostSetHostsResponse {
|
||||
|
||||
Reference in new issue
Block a user