get method
Get the key value entry value for a key value map scoped to an organization, environment, or API proxy.
Note: Supported for Apigee hybrid 1.8.x and higher.
Request parameters:
name
- Required. Scope as indicated by the URI in which to fetch the key
value map entry/value. Use one of the following structures in your
request: *
organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}
.
*
organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}
*
organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}
.
If the KeyValueMap is under an API Proxy resource that has the space
attribute set, IAM permissions are checked against the Space resource
path. To learn more, read the
Apigee Spaces Overview.
Value must have pattern
^organizations/\[^/\]+/keyvaluemaps/\[^/\]+/entries/\[^/\]+$
.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudApigeeV1KeyValueEntry.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<GoogleCloudApigeeV1KeyValueEntry> get(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudApigeeV1KeyValueEntry.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}