ফিল্ড মাস্ক হল এপিআই কলারদের জন্য সেই ক্ষেত্রগুলি তালিকাভুক্ত করার একটি উপায় যা একটি অনুরোধ ফেরত দেওয়া উচিত৷ একটি ফিল্ড মাস্ক ব্যবহার করা API-কে অপ্রয়োজনীয় কাজ এড়াতে এবং কর্মক্ষমতা উন্নত করতে দেয়।
একটি ফিল্ড মাস্ক একটি URL ক্যোয়ারী প্যারামিটার বা একটি HTTP বা gRPC হেডার হিসাবে নির্দিষ্ট করা যেতে পারে:
URL ক্যোয়ারী প্যারামিটার | HTTP বা gRPC হেডার |
---|---|
$fields বা fields | X-Goog-FieldMask |
ফিল্ড মাস্ক সিনট্যাক্স
নিম্নলিখিত ক্ষেত্র মাস্ক উদাহরণ এই উদাহরণ প্রতিক্রিয়া ধরনের উপর ভিত্তি করে.
message ExampleResponse {
message Foo {
string foo1 = 1;
string foo2 = 2;
Bar foo3 = 3;
}
message Bar {
string bar1 = 1;
string bar2 = 2;
string bar3 = 3;
}
string field1 = 1;
repeated Foo field2 = 2;
}
নেস্টেড ক্ষেত্রগুলি ডট সিনট্যাক্স ব্যবহার করে বা বন্ধনীতে আবদ্ধ করে নির্বাচন করা যেতে পারে।
অভিব্যক্তি | আউটপুট |
---|---|
* | সমস্ত ক্ষেত্র এবং নেস্টেড ক্ষেত্র ফেরত দেয়। |
field1,field2 | field1 এবং field2 এর সমস্ত নেস্টেড ক্ষেত্র ফেরত দেয়। |
field1,field2.foo1 | field1 এবং field2.foo1 রিটার্ন করে। |
field1,field2(foo1) | field1 এবং field2.foo1 রিটার্ন করে। |
field1,field2(foo1,foo2) | রিটার্ন:field1 field2.foo1 field2.foo2 |
field1,field2(foo1,foo3(bar1,bar2)) | রিটার্ন:field1 field2.foo1 field2.foo3.bar1 field2.foo3.bar2 |
ফিল্ড মাস্ক হল এপিআই কলারদের জন্য সেই ক্ষেত্রগুলি তালিকাভুক্ত করার একটি উপায় যা একটি অনুরোধ ফেরত দেওয়া উচিত৷ একটি ফিল্ড মাস্ক ব্যবহার করা API-কে অপ্রয়োজনীয় কাজ এড়াতে এবং কর্মক্ষমতা উন্নত করতে দেয়।
একটি ফিল্ড মাস্ক একটি URL ক্যোয়ারী প্যারামিটার বা একটি HTTP বা gRPC হেডার হিসাবে নির্দিষ্ট করা যেতে পারে:
URL ক্যোয়ারী প্যারামিটার | HTTP বা gRPC হেডার |
---|---|
$fields বা fields | X-Goog-FieldMask |
ফিল্ড মাস্ক সিনট্যাক্স
নিম্নলিখিত ক্ষেত্র মাস্ক উদাহরণ এই উদাহরণ প্রতিক্রিয়া ধরনের উপর ভিত্তি করে.
message ExampleResponse {
message Foo {
string foo1 = 1;
string foo2 = 2;
Bar foo3 = 3;
}
message Bar {
string bar1 = 1;
string bar2 = 2;
string bar3 = 3;
}
string field1 = 1;
repeated Foo field2 = 2;
}
নেস্টেড ক্ষেত্রগুলি ডট সিনট্যাক্স ব্যবহার করে বা বন্ধনীতে আবদ্ধ করে নির্বাচন করা যেতে পারে।
অভিব্যক্তি | আউটপুট |
---|---|
* | সমস্ত ক্ষেত্র এবং নেস্টেড ক্ষেত্র ফেরত দেয়। |
field1,field2 | field1 এবং field2 এর সমস্ত নেস্টেড ক্ষেত্র ফেরত দেয়। |
field1,field2.foo1 | field1 এবং field2.foo1 রিটার্ন করে। |
field1,field2(foo1) | field1 এবং field2.foo1 রিটার্ন করে। |
field1,field2(foo1,foo2) | রিটার্ন:field1 field2.foo1 field2.foo2 |
field1,field2(foo1,foo3(bar1,bar2)) | রিটার্ন:field1 field2.foo1 field2.foo3.bar1 field2.foo3.bar2 |