Package google.cloud.resourcesettings.v1alpha1

इंडेक्स

ResourceSettingsService

यह एक इंटरफ़ेस है. इसकी मदद से, संसाधन के पूरे क्रम में संसाधन की सेटिंग और सेटिंग वैल्यू के साथ इंटरैक्ट किया जा सकता है.

सेवाएं, उपयोगकर्ताओं के लिए कई सेटिंग दिखा सकती हैं. इनसे यह कंट्रोल किया जा सकता है कि उनके संसाधन कैसे काम करें. किसी Cloud संसाधन पर लागू की गई सेटिंग की वैल्यू का आकलन, क्रम के हिसाब से किया जाता है. साथ ही, वे वैल्यू उस संसाधन के सभी डिसेंडेंट को मिलती हैं.

सभी अनुरोधों के लिए, अगर आईएएम की जांच पूरी नहीं होती है या parent संसाधन किसी Cloud संगठन में नहीं है, तो google.rpc.Status के साथ google.rpc.Code.PERMISSION_DENIED दिखाता है. सभी अनुरोधों के लिए, अगर अनुरोध गलत तरीके से किया गया है, तो google.rpc.Status के साथ google.rpc.Code.INVALID_ARGUMENT दिखाता है.

ध्यान दें: ऐल्फ़ा स्टेज की सभी सेटिंग के लिए, Cloud Organizations में मौजूद ऐसे किसी भी संसाधन में सेटिंग मौजूद नहीं होती जो ऐल्फ़ा में नहीं है.

CreateSettingValue

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

सेटिंग वैल्यू बनाता है.

अगर सेटिंग मौजूद नहीं है, तो google.rpc.Status के साथ google.rpc.Code.NOT_FOUND दिखाता है. अगर दी गई सेटिंग की वैल्यू, Cloud संसाधन पर पहले से मौजूद है, तो यह फ़ंक्शन google.rpc.Code.ALREADY_EXISTS के साथ google.rpc.Status दिखाता है. अगर सेटिंग को सिर्फ़ पढ़ने के तौर पर फ़्लैग किया गया है, तो google.rpc.Status के साथ google.rpc.Code.FAILED_PRECONDITION दिखाता है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, पुष्टि करने की खास जानकारी देखें.
DeleteSettingValue

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

सेटिंग की वैल्यू मिटाता है. अगर सेटिंग की वैल्यू मौजूद नहीं है, तो ऑपरेशन नहीं होगा.

अगर सेटिंग या सेटिंग की वैल्यू मौजूद नहीं है, तो google.rpc.Status के साथ google.rpc.Code.NOT_FOUND दिखाता है. अगर सेटिंग वैल्यू के लिए DeleteSetting को पहले किए गए कॉल से, पहले ही सफलता कोड मिल चुका है, तो सेटिंग वैल्यू मौजूद नहीं होगी. अगर सेटिंग को सिर्फ़ पढ़ने के तौर पर फ़्लैग किया गया है, तो google.rpc.Status के साथ google.rpc.Code.FAILED_PRECONDITION दिखाता है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, पुष्टि करने की खास जानकारी देखें.
GetSettingValue

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

सेटिंग की वैल्यू मिलती है.

अगर सेटिंग की वैल्यू मौजूद नहीं है, तो google.rpc.Status के साथ google.rpc.Code.NOT_FOUND दिखाता है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, पुष्टि करने की खास जानकारी देखें.
ListSettings

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

यह कुकी, क्लाउड संसाधन parent पर उपलब्ध सभी सेटिंग की सूची बनाती है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, पुष्टि करने की खास जानकारी देखें.
LookupEffectiveSettingValue

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

यह फ़ंक्शन, Cloud संसाधन parent पर किसी सेटिंग की असरदार सेटिंग वैल्यू का हिसाब लगाता है. सेटिंग की प्रभावी वैल्यू, क्लाउड रिसोर्स पर कैलकुलेट की गई सेटिंग की वैल्यू होती है. यह वैल्यू, दिए गए क्रम में इनमें से किसी एक विकल्प के तौर पर दिखती है. अगर पिछला विकल्प मौजूद नहीं है, तो अगले विकल्प का इस्तेमाल किया जाता है:

  1. दिए गए संसाधन पर सेटिंग की वैल्यू
  2. दिए गए संसाधन के सबसे नज़दीकी पूर्वज पर सेटिंग की वैल्यू
  3. सेटिंग की डिफ़ॉल्ट वैल्यू
  4. सेटिंग की खाली वैल्यू, जिसे SettingValue के तौर पर तय किया जाता है. इसमें सभी फ़ील्ड सेट नहीं होते

अगर सेटिंग मौजूद नहीं है, तो google.rpc.Status के साथ google.rpc.Code.NOT_FOUND दिखाता है.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, पुष्टि करने की खास जानकारी देखें.
SearchSettingValues

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

यह क्वेरी, parent रिसॉर्स पर मौजूद सभी सेटिंग वैल्यू खोजती है. सेटिंग की वैल्यू, किसी खास सेटिंग की वैल्यू तक सीमित नहीं होती हैं.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, पुष्टि करने की खास जानकारी देखें.
UpdateSettingValue

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

सेटिंग की वैल्यू अपडेट करता है.

अगर सेटिंग या सेटिंग की वैल्यू मौजूद नहीं है, तो google.rpc.Status के साथ google.rpc.Code.NOT_FOUND दिखाता है. अगर सेटिंग को सिर्फ़ पढ़ने के तौर पर फ़्लैग किया गया है, तो google.rpc.Status के साथ google.rpc.Code.FAILED_PRECONDITION दिखाता है. अनुरोध में दिया गया ईटैग, सेटिंग की वैल्यू के सेव किए गए ईटैग से मेल न खाने पर, google.rpc.Code.ABORTED के साथ google.rpc.Status दिखाता है.

ध्यान दें: सेटिंग की दी गई वैल्यू, सभी फ़ील्ड की वैल्यू को पूरी तरह से बदल देगी.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, पुष्टि करने की खास जानकारी देखें.

CreateSettingValueRequest

CreateSettingValue के लिए अनुरोध.

फ़ील्ड
setting_value

SettingValue

बनाई जाने वाली सेटिंग वैल्यू. फ़ील्ड की ज़रूरी शर्तों के लिए, SettingValue देखें.

अनुमति देने के लिए, तय किए गए संसाधन settingValue पर यह IAM अनुमति ज़रूरी है:

  • resourcesettings.settingvalues.create

DeleteSettingValueRequest

DeleteSettingValue के लिए अनुरोध.

फ़ील्ड
name

string

मिटाई जाने वाली सेटिंग वैल्यू का नाम. नाम रखने से जुड़ी ज़रूरी शर्तों के लिए, SettingValue देखें.

अनुमति देने के लिए, तय किए गए संसाधन name पर यह IAM अनुमति ज़रूरी है:

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

यह एक फ़्लैग है. इसकी मदद से, read_only सेटिंग की वैल्यू मिटाई जा सकती है. चेतावनी: इसे अपने जोखिम पर इस्तेमाल करें. सिर्फ़ पढ़ने की सेटिंग की वैल्यू मिटाने की कार्रवाई को पहले जैसा नहीं किया जा सकता. इसका मतलब है कि इसे फिर से नहीं बनाया जा सकता.

GetSettingValueRequest

GetSettingValue के लिए अनुरोध.

फ़ील्ड
name

string

सेटिंग की उस वैल्यू का नाम जिसे पाना है. नाम रखने से जुड़ी ज़रूरी शर्तों के लिए, SettingValue देखें.

अनुमति देने के लिए, तय किए गए संसाधन name पर यह IAM अनुमति ज़रूरी है:

  • resourcesettings.settingvalues.get

ListSettingsRequest

ListSettings के लिए अनुरोध.

फ़ील्ड
parent

string

वह Cloud संसाधन जिससे सेटिंग जुड़ी है. यह इनमें से किसी एक फ़ॉर्म में होना चाहिए:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

अनुमति देने के लिए, तय किए गए संसाधन parent पर यह IAM अनुमति ज़रूरी है:

  • resourcesettings.settings.list
page_size

int32

इस्तेमाल नहीं किया गया. लौटाए जाने वाले पेज का साइज़.
page_token

string

इस्तेमाल नहीं किया गया. इस पेज टोकन का इस्तेमाल, अगला पेज पाने के लिए किया जाता है.

ListSettingsResponse

ListSettings से मिला जवाब.

फ़ील्ड
settings[]

Setting

उन सेटिंग की सूची जो बताए गए Cloud संसाधन के लिए उपलब्ध हैं.
next_page_token

string

इस्तेमाल नहीं किया गया. इस पेज टोकन का इस्तेमाल, अगला पेज पाने के लिए किया जाता है.

LookupEffectiveSettingValueRequest

LookupEffectiveSettingValue के लिए अनुरोध.

फ़ील्ड
parent

string

वह सेटिंग जिसके लिए असरदार वैल्यू का आकलन किया जाएगा. नाम रखने से जुड़ी ज़रूरी शर्तों के लिए, Setting देखें.

अनुमति देने के लिए, तय किए गए संसाधन parent पर यह IAM अनुमति ज़रूरी है:

  • resourcesettings.settingvalues.get

SearchSettingValuesRequest

SearchSettingValues के लिए अनुरोध.

फ़ील्ड
parent

string

वह Cloud संसाधन जिससे सेटिंग जुड़ी है. यह इनमें से किसी एक फ़ॉर्म में होना चाहिए:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

अनुमति देने के लिए, तय किए गए संसाधन parent पर यह IAM अनुमति ज़रूरी है:

  • resourcesettings.settingvalues.list
page_size

int32

इस्तेमाल नहीं किया गया. लौटाए जाने वाले पेज का साइज़.
page_token

string

इस्तेमाल नहीं किया गया. इस पेज टोकन का इस्तेमाल, अगला पेज पाने के लिए किया जाता है.

SearchSettingValuesResponse

SearchSettingValues से मिला जवाब.

फ़ील्ड
setting_values[]

SettingValue

Cloud resource पर मौजूद सेटिंग की सभी वैल्यू.
next_page_token

string

इस्तेमाल नहीं किया गया. इस पेज टोकन का इस्तेमाल, अगला पेज पाने के लिए किया जाता है.

सेटिंग

वैल्यू सेट करने के लिए स्कीमा. किसी Cloud संसाधन पर, कोई सेटिंग ज़्यादा से ज़्यादा एक सेटिंग वैल्यू की पैरंट हो सकती है.

फ़ील्ड
name

string

सेटिंग के संसाधन का नाम. यह इनमें से किसी एक फ़ॉर्म में होना चाहिए:

  • projects/{project_number}/settings/{setting_name}
  • folders/{folder_id}/settings/{setting_name}
  • organizations/{organization_id}/settings/{setting_name}

उदाहरण के लिए, "/projects/123/settings/gcp-enableMyFeature"
display_name

string

इस सेटिंग का ऐसा नाम जिसे आसानी से पढ़ा जा सकता है.
description

string

इस सेटिंग के काम करने के तरीके के बारे में पूरी जानकारी.
read_only

bool

यह फ़्लैग दिखाता है कि इस सेटिंग की वैल्यू में बदलाव नहीं किया जा सकता. अपडेट और वजहों के लिए, सेटिंग का दस्तावेज़ देखें. हालांकि, अगर DeleteSettingValueRequest.ignore_read_only को सही पर सेट किया गया है, तो DeleteSettingValue का इस्तेमाल करके इसे मिटाया जा सकता है. इस फ़्लैग का इस्तेमाल करने का मतलब है कि सेटिंग की वैल्यू को फिर से नहीं बनाया जा सकता. ज़्यादा जानकारी के लिए, DeleteSettingValueRequest.ignore_read_only पर जाएं.
data_type

DataType

इस सेटिंग के लिए डेटा टाइप.
default_value

Value

अगर सेटिंग की कोई वैल्यू साफ़ तौर पर सेट नहीं की गई है, तो LookupEffectiveSettingValue को मिली वैल्यू.

ध्यान दें: सभी सेटिंग की डिफ़ॉल्ट वैल्यू नहीं होती.

DataType

इस सेटिंग की वैल्यू सेट करने के लिए डेटा टाइप. उपलब्ध डेटा टाइप के बारे में ज़्यादा जानने के लिए, Value देखें.

Enums
DATA_TYPE_UNSPECIFIED डेटा टाइप की जानकारी नहीं दी गई है.
BOOLEAN बूलियन सेटिंग.
STRING स्ट्रिंग की सेटिंग.
STRING_SET स्ट्रिंग सेट करने की सेटिंग.

SettingValue

किसी सेटिंग का इंस्टैंटिएशन. हर सेटिंग वैल्यू, उससे जुड़ी सेटिंग की पैरंट होती है.

फ़ील्ड
name

string

सेटिंग की वैल्यू के संसाधन का नाम. यह इनमें से किसी एक फ़ॉर्म में होना चाहिए:

  • projects/{project_number}/settings/{setting_name}/value
  • folders/{folder_id}/settings/{setting_name}/value
  • organizations/{organization_id}/settings/{setting_name}/value

उदाहरण के लिए, "/projects/123/settings/gcp-enableMyFeature/value"
value

Value

सेटिंग की वैल्यू. Value का डेटा टाइप, पैरंट सेटिंग के तय किए गए डेटा टाइप के साथ हमेशा मेल खाना चाहिए.
etag

string

इस फ़िंगरप्रिंट का इस्तेमाल, ऑप्टिमिस्टिक कॉन्करेंसी के लिए किया जाता है. ज़्यादा जानकारी के लिए, UpdateSettingValue पर जाएं.
read_only

bool

सिर्फ़ आउटपुट के लिए. यह फ़्लैग दिखाता है कि इस सेटिंग की वैल्यू में बदलाव नहीं किया जा सकता. हालांकि, अगर DeleteSettingValueRequest.ignore_read_only को सही पर सेट किया गया है, तो DeleteSettingValue का इस्तेमाल करके इसे मिटाया जा सकता है. इस फ़्लैग का इस्तेमाल करने का मतलब है कि सेटिंग की वैल्यू को फिर से नहीं बनाया जा सकता. यह फ़्लैग, पैरंट सेटिंग से लिया गया है. इसका मकसद, उपयोगकर्ताओं को सुविधा देना है. ज़्यादा जानकारी के लिए, Setting.read_only पर जाएं.
update_time

Timestamp

सिर्फ़ आउटपुट के लिए. इस टाइमस्टैंप से पता चलता है कि सेटिंग की वैल्यू को पिछली बार कब अपडेट किया गया था.

UpdateSettingValueRequest

UpdateSettingValue के लिए अनुरोध.

फ़ील्ड
setting_value

SettingValue

अपडेट की जाने वाली सेटिंग वैल्यू. फ़ील्ड की ज़रूरी शर्तों के लिए, SettingValue देखें.

अनुमति देने के लिए, तय किए गए संसाधन settingValue पर यह IAM अनुमति ज़रूरी है:

  • resourcesettings.settingvalues.update

मान

सेटिंग की वैल्यू में मौजूद डेटा.

फ़ील्ड
यूनियन फ़ील्ड value. यह कुकी, डेटा टाइप और उससे जुड़ी वैल्यू चुनती है. value इनमें से सिर्फ़ एक हो सकता है:
boolean_value

bool

इस वैल्यू को बूलियन वैल्यू के तौर पर तय करता है.
string_value

string

इस वैल्यू को स्ट्रिंग वैल्यू के तौर पर तय करता है.
string_set_value

StringSet

इस वैल्यू को StringSet के तौर पर तय करता है.

StringSet

यह स्ट्रिंग सेट वैल्यू है, जिसमें स्ट्रिंग का सेट सेव किया जा सकता है. हर स्ट्रिंग में ज़्यादा से ज़्यादा 60 वर्ण हो सकते हैं. साथ ही, स्ट्रिंग सेट में ज़्यादा से ज़्यादा 50 स्ट्रिंग हो सकती हैं.

फ़ील्ड
values[]

string

सेट में मौजूद स्ट्रिंग