Package google.firestore.admin.v1beta1

সূচক

ফায়ারস্টোর অ্যাডমিন

ক্লাউড ফায়ারস্টোর অ্যাডমিন API।

এই API ক্লাউড ফায়ারস্টোরের জন্য বিভিন্ন প্রশাসনিক পরিষেবা প্রদান করে।

ধারণা

প্রজেক্ট, ডেটাবেস, নেমস্পেস, কালেকশন এবং ডকুমেন্ট Google ক্লাউড ফায়ারস্টোর এপিআই-তে সংজ্ঞায়িত হিসাবে ব্যবহার করা হয়।

অপারেশন: একটি অপারেশন ব্যাকগ্রাউন্ডে সম্পাদিত কাজকে প্রতিনিধিত্ব করে।

সেবা

সূচক

সূচক পরিষেবা ক্লাউড ফায়ারস্টোর সূচকগুলি পরিচালনা করে।

সূচক তৈরি অ্যাসিঙ্ক্রোনাসভাবে সঞ্চালিত হয়। প্রতিটি অসিঙ্ক্রোনাস অপারেশনের জন্য একটি অপারেশন রিসোর্স তৈরি করা হয়। অপারেশনের অবস্থা (কোনও ত্রুটির সম্মুখীন হওয়া সহ) অপারেশন রিসোর্সের মাধ্যমে জিজ্ঞাসা করা যেতে পারে।

মেটাডেটা

ক্লাউড ফায়ারস্টোরে ডেটা সম্পর্কে মেটাডেটা এবং পরিসংখ্যানগত তথ্য প্রদান করে। এই API এর অংশ হিসাবে প্রদত্ত ডেটা পুরানো হতে পারে৷

অপারেশন

অপারেশন সংগ্রহ নির্দিষ্ট প্রকল্পের জন্য সম্পাদিত ক্রিয়াকলাপের একটি রেকর্ড সরবরাহ করে (প্রগতিশীল যেকোনো অপারেশন সহ)। অপারেশনগুলি সরাসরি তৈরি করা হয় না তবে অন্যান্য সংগ্রহ বা সংস্থানগুলিতে কলের মাধ্যমে।

একটি অপারেশন যা এখনও সম্পন্ন হয়নি তা বাতিল হতে পারে। বাতিল করার অনুরোধটি অ্যাসিঙ্ক্রোনাস এবং বাতিল করার অনুরোধ করার পরে কিছু সময়ের জন্য অপারেশন চলতে পারে।

সম্পাদিত একটি অপারেশন মুছে ফেলা হতে পারে যাতে এটি আর অপারেশন সংগ্রহের অংশ হিসাবে তালিকাভুক্ত না হয়।

অপারেশনগুলি FirestoreAdmin পরিষেবা দ্বারা তৈরি করা হয়, কিন্তু পরিষেবা google.longrunning.Operations মাধ্যমে অ্যাক্সেস করা হয়৷

সূচক তৈরি করুন

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

নির্দিষ্ট সূচক তৈরি করে। একটি সদ্য তৈরি সূচকের প্রাথমিক অবস্থা CREATING । ফিরে আসা google.longrunning.Operation শেষ হলে, রাজ্য READY হবে। যদি সূচীটি ইতিমধ্যেই বিদ্যমান থাকে, তাহলে কলটি একটি ALREADY_EXISTS স্থিতি প্রদান করবে৷

তৈরির সময়, প্রক্রিয়াটি একটি ত্রুটির কারণ হতে পারে, এই ক্ষেত্রে সূচকটি ERROR অবস্থায় চলে যাবে। ত্রুটির কারণ হওয়া ডেটা ঠিক করে, delete দিয়ে সূচীটি সরিয়ে তারপর create দিয়ে সূচীটি পুনরায় তৈরি করে প্রক্রিয়াটি পুনরুদ্ধার করা যেতে পারে।

একটি একক ক্ষেত্র সহ সূচক তৈরি করা যাবে না।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।

ডিলিট ইনডেক্স

rpc DeleteIndex( DeleteIndexRequest ) returns ( Empty )

একটি সূচক মুছে দেয়।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।

নথিপত্র রপ্তানি করুন

rpc ExportDocuments( ExportDocumentsRequest ) returns ( Operation )

Google ক্লাউড ফায়ারস্টোর থেকে অন্য স্টোরেজ সিস্টেমে, যেমন Google ক্লাউড স্টোরেজ থেকে সমস্ত নথির একটি অনুলিপি বা একটি উপসেট রপ্তানি করে৷ নথির সাম্প্রতিক আপডেটগুলি রপ্তানিতে প্রতিফলিত নাও হতে পারে৷ রপ্তানিটি ব্যাকগ্রাউন্ডে ঘটে এবং এর অগ্রগতি তৈরি করা অপারেশন রিসোর্সের মাধ্যমে পর্যবেক্ষণ ও পরিচালনা করা যেতে পারে। একটি রপ্তানির আউটপুট শুধুমাত্র একবার সংশ্লিষ্ট অপারেশন সম্পন্ন হলে ব্যবহার করা যেতে পারে। যদি একটি রপ্তানি অপারেশন সম্পূর্ণ হওয়ার আগে বাতিল করা হয় তবে এটি Google ক্লাউড স্টোরেজে আংশিক ডেটা রেখে যেতে পারে।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।

GetIndex

rpc GetIndex( GetIndexRequest ) returns ( Index )

একটি সূচক পায়।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।

নথিপত্র আমদানি করুন

rpc ImportDocuments( ImportDocumentsRequest ) returns ( Operation )

Google ক্লাউড ফায়ারস্টোরে নথি আমদানি করে। একই নামের বিদ্যমান নথিগুলি ওভাররাইট করা হয়েছে৷ আমদানিটি পটভূমিতে ঘটে এবং এর অগ্রগতি তৈরি করা অপারেশন রিসোর্সের মাধ্যমে নিরীক্ষণ ও পরিচালনা করা যেতে পারে। যদি একটি ImportDocuments অপারেশন বাতিল করা হয়, তাহলে এটি সম্ভব যে ডেটার একটি উপসেট ইতিমধ্যেই Cloud Firestore-এ আমদানি করা হয়েছে৷

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।

তালিকা ইনডেক্স

rpc ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )

নির্দিষ্ট ফিল্টারগুলির সাথে মেলে এমন সূচীগুলি তালিকাভুক্ত করে৷

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।

IndexRequest তৈরি করুন

FirestoreAdmin.CreateIndex এর জন্য অনুরোধ।

ক্ষেত্র
parent

string

এই সূচকটি যে ডাটাবেসের জন্য প্রযোজ্য হবে তার নাম। যেমন: projects/{project_id}/databases/{database_id}

index

Index

সূচক তৈরি করতে হবে। নাম এবং রাজ্য ক্ষেত্রগুলি শুধুমাত্র আউটপুট এবং উপেক্ষা করা হবে৷ নির্দিষ্ট একক ক্ষেত্রের সূচী তৈরি বা মুছে ফেলা যাবে না।

ডিলিট ইনডেক্স রিকোয়েস্ট

FirestoreAdmin.DeleteIndex এর জন্য অনুরোধ।

ক্ষেত্র
name

string

সূচকের নাম। যেমন: projects/{project_id}/databases/{database_id}/indexes/{index_id}

রপ্তানি নথি মেটাডেটা

এক্সপোর্ট ডকুমেন্টস অপারেশনের জন্য মেটাডেটা।

ক্ষেত্র
start_time

Timestamp

যে সময় অপারেশনের কাজ শুরু হয়।

end_time

Timestamp

সফলভাবে অথবা অন্যথায় অপারেশন শেষ হওয়ার সময়। অপারেশন এখনও সক্রিয় থাকলে আনসেট করুন।

operation_state

OperationState

রপ্তানি কার্যক্রমের অবস্থা।

progress_documents

Progress

প্রক্রিয়াকৃত নথির সংখ্যার একটি অনুমান।

progress_bytes

Progress

প্রক্রিয়াকৃত বাইট সংখ্যার একটি অনুমান।

collection_ids[]

string

কোন সংগ্রহ আইডি রপ্তানি করা হচ্ছে.

output_uri_prefix

string

যেখানে সত্তা রপ্তানি করা হচ্ছে।

রপ্তানি নথি অনুরোধ

FirestoreAdmin.ExportDocuments এর জন্য অনুরোধ।

ক্ষেত্র
name

string

রপ্তানি করার জন্য ডাটাবেস। ফর্মের হওয়া উচিত: projects/{project_id}/databases/{database_id} ।

collection_ids[]

string

কোন কালেকশন আইডি এক্সপোর্ট করতে হবে। অনির্দিষ্ট মানে সমস্ত সংগ্রহ।

output_uri_prefix

string

আউটপুট URI. বর্তমানে শুধুমাত্র ফর্মের Google ক্লাউড স্টোরেজ URI সমর্থন করে: gs://BUCKET_NAME[/NAMESPACE_PATH] , যেখানে BUCKET_NAME হল Google ক্লাউড স্টোরেজ বাকেটের নাম এবং NAMESPACE_PATH হল একটি ঐচ্ছিক Google ক্লাউড স্টোরেজ নামস্থান পাথ৷ একটি নাম নির্বাচন করার সময়, Google ক্লাউড স্টোরেজ নামকরণের নির্দেশিকাগুলি বিবেচনা করতে ভুলবেন না: https://cloud.google.com/storage/docs/naming । যদি URI একটি বালতি হয় (একটি নামস্থান পাথ ছাড়া), তাহলে শুরুর সময়ের উপর ভিত্তি করে একটি উপসর্গ তৈরি করা হবে।

রপ্তানি নথি প্রতিক্রিয়া

google.longrunning.Operation প্রতিক্রিয়া ফিল্ডে ফিরে এসেছে।

ক্ষেত্র
output_uri_prefix

string

আউটপুট ফাইলের অবস্থান। অপারেশন সফলভাবে শেষ হওয়ার পরে এটি ক্লাউড ফায়ারস্টোরে (এই প্রকল্প বা অন্য প্রকল্প) একটি আমদানি শুরু করতে ব্যবহার করা যেতে পারে।

GetIndexRequest

FirestoreAdmin.GetIndex এর জন্য অনুরোধ।

ক্ষেত্র
name

string

সূচকের নাম। যেমন: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ডকুমেন্টস মেটাডেটা আমদানি করুন

ইমপোর্ট ডকুমেন্টস অপারেশনের জন্য মেটাডেটা।

ক্ষেত্র
start_time

Timestamp

যে সময় অপারেশনের কাজ শুরু হয়।

end_time

Timestamp

সফলভাবে অথবা অন্যথায় অপারেশন শেষ হওয়ার সময়। অপারেশন এখনও সক্রিয় থাকলে আনসেট করুন।

operation_state

OperationState

আমদানি কার্যক্রমের অবস্থা।

progress_documents

Progress

প্রক্রিয়াকৃত নথির সংখ্যার একটি অনুমান।

progress_bytes

Progress

প্রক্রিয়াকৃত বাইট সংখ্যার একটি অনুমান।

collection_ids[]

string

কোন সংগ্রহ আইডি আমদানি করা হচ্ছে.

input_uri_prefix

string

নথি আমদানি করা হচ্ছে অবস্থান.

ডকুমেন্টস অনুরোধ আমদানি করুন

FirestoreAdmin.ImportDocuments এর জন্য অনুরোধ।

ক্ষেত্র
name

string

ডাটাবেস আমদানি করতে। ফর্মের হওয়া উচিত: projects/{project_id}/databases/{database_id} ।

collection_ids[]

string

কোন কালেকশন আইডি আমদানি করতে হবে। অনির্দিষ্ট মানে আমদানিতে অন্তর্ভুক্ত সমস্ত সংগ্রহ।

input_uri_prefix

string

এক্সপোর্ট করা ফাইলের অবস্থান। এটি অবশ্যই সফলভাবে সম্পন্ন হয়েছে এমন একটি রপ্তানি থেকে ExportDocumentsResponse-এর output_uri_prefix এর সাথে মেলে। দেখুন: google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix ।

সূচক

একটি সূচক সংজ্ঞা।

ক্ষেত্র
name

string

সূচকের সম্পদের নাম। শুধুমাত্র আউটপুট।

collection_id

string

এই সূচকটি যে সংগ্রহের আইডিতে প্রযোজ্য। প্রয়োজন।

fields[]

IndexField

সূচী ক্ষেত্র.

state

State

সূচকের অবস্থা। শুধুমাত্র আউটপুট।

অবস্থা

একটি সূচকের অবস্থা। সূচক তৈরির সময়, একটি সূচক CREATING অবস্থায় থাকবে। সূচী সফলভাবে তৈরি করা হলে, এটি READY অবস্থায় স্থানান্তরিত হবে। সূচী তৈরি করতে সক্ষম না হলে, এটি ERROR অবস্থায় স্থানান্তরিত হবে।

Enums
STATE_UNSPECIFIED রাষ্ট্র অনির্দিষ্ট।
CREATING সূচক তৈরি করা হচ্ছে। সূচকের জন্য একটি সক্রিয় দীর্ঘমেয়াদী অপারেশন আছে। একটি নথি লেখার সময় সূচক আপডেট করা হয়। কিছু সূচক ডেটা বিদ্যমান থাকতে পারে।
READY সূচক ব্যবহার করার জন্য প্রস্তুত. একটি নথি লেখার সময় সূচক আপডেট করা হয়। এটি প্রযোজ্য সমস্ত সঞ্চিত নথি থেকে সূচকটি সম্পূর্ণরূপে জনবহুল।
ERROR সূচক তৈরি করা হচ্ছে, কিন্তু কিছু ভুল হয়েছে। সূচকের জন্য কোন সক্রিয় দীর্ঘমেয়াদী ক্রিয়াকলাপ নেই, এবং অতি সম্প্রতি সমাপ্ত দীর্ঘ-চলমান অপারেশন ব্যর্থ হয়েছে৷ একটি নথি লেখার সময় সূচক আপডেট করা হয় না। কিছু সূচক ডেটা বিদ্যমান থাকতে পারে।

ইনডেক্সফিল্ড

একটি সূচকের ক্ষেত্র।

ক্ষেত্র
field_path

string

মাঠের পথ। [google.firestore.v1beta1.Document.fields][fields] দ্বারা বর্ণিত ফিল্ড পাথ স্পেসিফিকেশনের সাথে মিলতে হবে। বিশেষ ক্ষেত্রের পথ __name__ নিজে থেকে বা একটি পথের শেষে ব্যবহার করা যেতে পারে। __type__ শুধুমাত্র পথের শেষে ব্যবহার করা যেতে পারে।

mode

Mode

ক্ষেত্রের মোড.

মোড

মোড নির্ধারণ করে কিভাবে একটি ক্ষেত্র সূচিত করা হয়।

Enums
MODE_UNSPECIFIED মোড অনির্দিষ্ট.
ASCENDING ক্ষেত্রের মানগুলিকে ইন্ডেক্স করা হয় যাতে ক্রমবর্ধমান ক্রমানুসারে সমর্থন করা যায় এবং <, >, <=, >=, এবং = দ্বারা অনুসন্ধান করা যায়।
DESCENDING ক্ষেত্রের মানগুলিকে সূচিত করা হয় যাতে অবরোহ ক্রমে অনুক্রম সমর্থন করা যায় এবং <, >, <=, >=, এবং = দ্বারা অনুসন্ধান করা যায়।
ARRAY_CONTAINS ARRAY_CONTAINS ক্যোয়ারী ব্যবহার করে সদস্যতা সমর্থন করার জন্য ক্ষেত্রের অ্যারের মানগুলিকে সূচিত করা হয়েছে৷

IndexOperationMetadata

সূচক অপারেশনের জন্য মেটাডেটা। এই মেটাডেটা google.longrunning.Operation এর মেটাডেটা ক্ষেত্রকে পপুলেট করে।

ক্ষেত্র
start_time

Timestamp

যে সময় অপারেশনের কাজ শুরু হয়।

end_time

Timestamp

সফলভাবে অথবা অন্যথায় অপারেশন শেষ হওয়ার সময়। অপারেশন এখনও সক্রিয় থাকলে আনসেট করুন।

index

string

সূচক সম্পদ যে এই অপারেশন কাজ করছে. যেমন: projects/{project_id}/databases/{database_id}/indexes/{index_id}

operation_type

OperationType

সূচক অপারেশনের ধরন।

cancelled

bool

google.longrunning.Operation বাতিল করা হলে সত্য। বাতিলকরণ প্রক্রিয়াধীন থাকলে, বাতিল করা সত্য হবে কিন্তু google.longrunning.Operation.done মিথ্যা হবে।

document_progress

Progress

বিদ্যমান অপারেশনের অগ্রগতি, নথির সংখ্যায় পরিমাপ করা হয়।

অপারেশন টাইপ

সূচক অপারেশনের ধরন।

Enums
OPERATION_TYPE_UNSPECIFIED অনির্দিষ্ট। সার্ভার দ্বারা সেট কখনও.
CREATING_INDEX অপারেশন সূচক তৈরি করা হয়. একটি CreateIndex কল দ্বারা সূচনা.

তালিকা ইনডেক্সের অনুরোধ

FirestoreAdmin.ListIndexes এর জন্য অনুরোধ।

ক্ষেত্র
parent

string

ডাটাবেসের নাম। যেমন: projects/{project_id}/databases/{database_id}

filter

string

page_size

int32

স্ট্যান্ডার্ড তালিকা পৃষ্ঠার আকার।

page_token

string

স্ট্যান্ডার্ড লিস্ট পেজ টোকেন।

তালিকা সূচক প্রতিক্রিয়া

FirestoreAdmin.ListIndexes এর প্রতিক্রিয়া।

ক্ষেত্র
indexes[]

Index

সূচী.

next_page_token

string

আদর্শ তালিকা পরবর্তী পৃষ্ঠার টোকেন।

অবস্থান মেটাডেটা

এই ধরনের কোন ক্ষেত্র নেই.

google.cloud.location.Location.metadata এর জন্য মেটাডেটা বার্তা।

অপারেশন স্টেট

একটি চলমান অপারেশন জন্য বিভিন্ন সম্ভাব্য রাষ্ট্র.

Enums
STATE_UNSPECIFIED অনির্দিষ্ট।
INITIALIZING অনুরোধ প্রক্রিয়াকরণের জন্য প্রস্তুত করা হচ্ছে.
PROCESSING অনুরোধ সক্রিয়ভাবে প্রক্রিয়া করা হচ্ছে.
CANCELLING ব্যবহারকারীর অপারেশনে google.longrunning.Operations.CancelOperation কল করার পরে অনুরোধটি বাতিল হওয়ার প্রক্রিয়াধীন রয়েছে৷
FINALIZING অনুরোধ প্রক্রিয়া করা হয়েছে এবং এটি চূড়ান্ত পর্যায়ে রয়েছে।
SUCCESSFUL অনুরোধ সফলভাবে সম্পন্ন হয়েছে.
FAILED অনুরোধটি প্রক্রিয়া করা শেষ হয়েছে, কিন্তু একটি ত্রুটির সম্মুখীন হয়েছে৷
CANCELLED ব্যবহারকারী google.longrunning.Operations.CancelOperation কল করার পরে অনুরোধটি বাতিল করা শেষ হয়েছে৷

অগ্রগতি

একটি নির্দিষ্ট মেট্রিকের অগ্রগতি পরিমাপ করে।

ক্ষেত্র
work_completed

int64

কত কাজ শেষ হয়েছে তার হিসাব। মনে রাখবেন এটি work_estimated এর চেয়ে বেশি হতে পারে।

work_estimated

int64

কত কাজ করতে হবে তার একটি অনুমান। কাজের হিসাব অনুপলব্ধ হলে শূন্য। কাজের অগ্রগতির সাথে সাথে পরিবর্তন হতে পারে।