From 2f3e4c478c3071ec76d14506a96d771f3abeb1a8 Mon Sep 17 00:00:00 2001 From: Chao-Han Tsai Date: Wed, 21 Apr 2021 13:20:55 -0700 Subject: [PATCH] add comment to request/response --- .../flyteidl/datacatalog/datacatalog.pb.go | 4 ++ gen/pb-java/datacatalog/Datacatalog.java | 32 +++++++++++++ .../datacatalog/datacatalog.proto.rst | 48 ++++++++++--------- protos/flyteidl/datacatalog/datacatalog.proto | 4 ++ 4 files changed, 66 insertions(+), 22 deletions(-) diff --git a/gen/pb-go/flyteidl/datacatalog/datacatalog.pb.go b/gen/pb-go/flyteidl/datacatalog/datacatalog.pb.go index 6c3edd40b..63c0a8d1f 100644 --- a/gen/pb-go/flyteidl/datacatalog/datacatalog.pb.go +++ b/gen/pb-go/flyteidl/datacatalog/datacatalog.pb.go @@ -966,6 +966,7 @@ func (*GetOrReserveArtifactResponse) XXX_OneofWrappers() []interface{} { } } +// Request to extend reservation type ExtendReservationRequest struct { DatasetId *DatasetID `protobuf:"bytes,1,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"` TagName string `protobuf:"bytes,2,opt,name=tag_name,json=tagName,proto3" json:"tag_name,omitempty"` @@ -1021,6 +1022,7 @@ func (m *ExtendReservationRequest) GetOwnerId() string { return "" } +// Response to extend reservation type ExtendReservationResponse struct { XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -1052,6 +1054,7 @@ func (m *ExtendReservationResponse) XXX_DiscardUnknown() { var xxx_messageInfo_ExtendReservationResponse proto.InternalMessageInfo +// Request to release reservation type ReleaseReservationRequest struct { DatasetId *DatasetID `protobuf:"bytes,1,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"` TagName string `protobuf:"bytes,2,opt,name=tag_name,json=tagName,proto3" json:"tag_name,omitempty"` @@ -1107,6 +1110,7 @@ func (m *ReleaseReservationRequest) GetOwnerId() string { return "" } +// Response to release reservation type ReleaseReservationResponse struct { XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` diff --git a/gen/pb-java/datacatalog/Datacatalog.java b/gen/pb-java/datacatalog/Datacatalog.java index 6b33a9e18..0edbb419d 100644 --- a/gen/pb-java/datacatalog/Datacatalog.java +++ b/gen/pb-java/datacatalog/Datacatalog.java @@ -13046,6 +13046,10 @@ public interface ExtendReservationRequestOrBuilder extends getOwnerIdBytes(); } /** + * 
+   * Request to extend reservation
+   *
+ * * Protobuf type {@code datacatalog.ExtendReservationRequest} */ public static final class ExtendReservationRequest extends @@ -13413,6 +13417,10 @@ protected Builder newBuilderForType( return builder; } /** + * 
+     * Request to extend reservation
+     *
+ * * Protobuf type {@code datacatalog.ExtendReservationRequest} */ public static final class Builder extends @@ -13893,6 +13901,10 @@ public interface ExtendReservationResponseOrBuilder extends com.google.protobuf.MessageOrBuilder { } /** + * 
+   * Response to extend reservation
+   *
+ * * Protobuf type {@code datacatalog.ExtendReservationResponse} */ public static final class ExtendReservationResponse extends @@ -14107,6 +14119,10 @@ protected Builder newBuilderForType( return builder; } /** + * 
+     * Response to extend reservation
+     *
+ * * Protobuf type {@code datacatalog.ExtendReservationResponse} */ public static final class Builder extends @@ -14337,6 +14353,10 @@ public interface ReleaseReservationRequestOrBuilder extends getOwnerIdBytes(); } /** + * 
+   * Request to release reservation
+   *
+ * * Protobuf type {@code datacatalog.ReleaseReservationRequest} */ public static final class ReleaseReservationRequest extends @@ -14704,6 +14724,10 @@ protected Builder newBuilderForType( return builder; } /** + * 
+     * Request to release reservation
+     *
+ * * Protobuf type {@code datacatalog.ReleaseReservationRequest} */ public static final class Builder extends @@ -15184,6 +15208,10 @@ public interface ReleaseReservationResponseOrBuilder extends com.google.protobuf.MessageOrBuilder { } /** + * 
+   * Response to release reservation
+   *
+ * * Protobuf type {@code datacatalog.ReleaseReservationResponse} */ public static final class ReleaseReservationResponse extends @@ -15398,6 +15426,10 @@ protected Builder newBuilderForType( return builder; } /** + * 
+     * Response to release reservation
+     *
+ * * Protobuf type {@code datacatalog.ReleaseReservationResponse} */ public static final class Builder extends diff --git a/gen/pb-protodoc/flyteidl/datacatalog/datacatalog.proto.rst b/gen/pb-protodoc/flyteidl/datacatalog/datacatalog.proto.rst index a26249f72..f559f98c1 100644 --- a/gen/pb-protodoc/flyteidl/datacatalog/datacatalog.proto.rst +++ b/gen/pb-protodoc/flyteidl/datacatalog/datacatalog.proto.rst @@ -492,8 +492,9 @@ reservation_status datacatalog.ExtendReservationRequest ------------------------------------ -`[datacatalog.ExtendReservationRequest proto] `_ +`[datacatalog.ExtendReservationRequest proto] `_ +Request to extend reservation .. code-block:: json @@ -525,8 +526,9 @@ owner_id datacatalog.ExtendReservationResponse ------------------------------------- -`[datacatalog.ExtendReservationResponse proto] `_ +`[datacatalog.ExtendReservationResponse proto] `_ +Response to extend reservation .. code-block:: json @@ -540,8 +542,9 @@ datacatalog.ExtendReservationResponse datacatalog.ReleaseReservationRequest ------------------------------------- -`[datacatalog.ReleaseReservationRequest proto] `_ +`[datacatalog.ReleaseReservationRequest proto] `_ +Request to release reservation .. code-block:: json @@ -573,8 +576,9 @@ owner_id datacatalog.ReleaseReservationResponse -------------------------------------- -`[datacatalog.ReleaseReservationResponse proto] `_ +`[datacatalog.ReleaseReservationResponse proto] `_ +Response to release reservation .. code-block:: json @@ -588,7 +592,7 @@ datacatalog.ReleaseReservationResponse datacatalog.Dataset ------------------- -`[datacatalog.Dataset proto] `_ +`[datacatalog.Dataset proto] `_ Dataset message. It is uniquely identified by DatasetID. @@ -623,7 +627,7 @@ partitionKeys datacatalog.Partition --------------------- -`[datacatalog.Partition proto] `_ +`[datacatalog.Partition proto] `_ An artifact could have multiple partitions and each partition can have an arbitrary string key/value pair @@ -652,7 +656,7 @@ value datacatalog.DatasetID --------------------- -`[datacatalog.DatasetID proto] `_ +`[datacatalog.DatasetID proto] `_ DatasetID message that is composed of several string fields. @@ -699,7 +703,7 @@ UUID datacatalog.Artifact -------------------- -`[datacatalog.Artifact proto] `_ +`[datacatalog.Artifact proto] `_ Artifact message. It is composed of several string fields. @@ -758,7 +762,7 @@ created_at datacatalog.ArtifactData ------------------------ -`[datacatalog.ArtifactData proto] `_ +`[datacatalog.ArtifactData proto] `_ ArtifactData that belongs to an artifact @@ -787,7 +791,7 @@ value datacatalog.Tag --------------- -`[datacatalog.Tag proto] `_ +`[datacatalog.Tag proto] `_ Tag message that is unique to a Dataset. It is associated to a single artifact and @@ -823,7 +827,7 @@ dataset datacatalog.Metadata -------------------- -`[datacatalog.Metadata proto] `_ +`[datacatalog.Metadata proto] `_ Metadata representation for artifacts and datasets @@ -846,7 +850,7 @@ key_map datacatalog.FilterExpression ---------------------------- -`[datacatalog.FilterExpression proto] `_ +`[datacatalog.FilterExpression proto] `_ Filter expression that is composed of a combination of single filters @@ -868,7 +872,7 @@ filters datacatalog.SinglePropertyFilter -------------------------------- -`[datacatalog.SinglePropertyFilter proto] `_ +`[datacatalog.SinglePropertyFilter proto] `_ A single property to filter on. @@ -925,7 +929,7 @@ operator Enum datacatalog.SinglePropertyFilter.ComparisonOperator -------------------------------------------------------- -`[datacatalog.SinglePropertyFilter.ComparisonOperator proto] `_ +`[datacatalog.SinglePropertyFilter.ComparisonOperator proto] `_ as use-cases come up we can add more operators, ex: gte, like, not eq etc. @@ -940,7 +944,7 @@ EQUALS datacatalog.ArtifactPropertyFilter ---------------------------------- -`[datacatalog.ArtifactPropertyFilter proto] `_ +`[datacatalog.ArtifactPropertyFilter proto] `_ Artifact properties we can filter by @@ -964,7 +968,7 @@ artifact_id datacatalog.TagPropertyFilter ----------------------------- -`[datacatalog.TagPropertyFilter proto] `_ +`[datacatalog.TagPropertyFilter proto] `_ Tag properties we can filter by @@ -987,7 +991,7 @@ tag_name datacatalog.PartitionPropertyFilter ----------------------------------- -`[datacatalog.PartitionPropertyFilter proto] `_ +`[datacatalog.PartitionPropertyFilter proto] `_ Partition properties we can filter by @@ -1010,7 +1014,7 @@ key_val datacatalog.KeyValuePair ------------------------ -`[datacatalog.KeyValuePair proto] `_ +`[datacatalog.KeyValuePair proto] `_ .. code-block:: json @@ -1037,7 +1041,7 @@ value datacatalog.DatasetPropertyFilter --------------------------------- -`[datacatalog.DatasetPropertyFilter proto] `_ +`[datacatalog.DatasetPropertyFilter proto] `_ Dataset properties we can filter by @@ -1089,7 +1093,7 @@ version datacatalog.PaginationOptions ----------------------------- -`[datacatalog.PaginationOptions proto] `_ +`[datacatalog.PaginationOptions proto] `_ Pagination options for making list requests @@ -1132,7 +1136,7 @@ sortOrder Enum datacatalog.PaginationOptions.SortOrder -------------------------------------------- -`[datacatalog.PaginationOptions.SortOrder proto] `_ +`[datacatalog.PaginationOptions.SortOrder proto] `_ .. _api_enum_value_datacatalog.PaginationOptions.SortOrder.DESCENDING: @@ -1151,7 +1155,7 @@ ASCENDING Enum datacatalog.PaginationOptions.SortKey ------------------------------------------ -`[datacatalog.PaginationOptions.SortKey proto] `_ +`[datacatalog.PaginationOptions.SortKey proto] `_ .. _api_enum_value_datacatalog.PaginationOptions.SortKey.CREATION_TIME: diff --git a/protos/flyteidl/datacatalog/datacatalog.proto b/protos/flyteidl/datacatalog/datacatalog.proto index 9b1f1622c..e83674b26 100644 --- a/protos/flyteidl/datacatalog/datacatalog.proto +++ b/protos/flyteidl/datacatalog/datacatalog.proto @@ -209,22 +209,26 @@ message GetOrReserveArtifactResponse { } } +// Request to extend reservation message ExtendReservationRequest { DatasetID dataset_id = 1; string tag_name = 2; string owner_id = 3; } +// Response to extend reservation message ExtendReservationResponse { } +// Request to release reservation message ReleaseReservationRequest { DatasetID dataset_id = 1; string tag_name = 2; string owner_id = 3; } +// Response to release reservation message ReleaseReservationResponse { }