get method
Retrieves a schema.
Request parameters:
customerId
- The unique ID for the customer's Google Workspace account.
In case of a multi-domain account, to fetch all groups for a customer, use
this field instead of domain
. You can also use the my_customer
alias
to represent your account's customerId
. The customerId
is also
returned as part of the [Users](/admin-sdk/directory/v1/reference/users)
resource. You must provide either the customer
or the domain
parameter.
schemaKey
- Name or immutable ID of the schema.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a Schema.
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<Schema> get(
core.String customerId,
core.String schemaKey, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'admin/directory/v1/customer/' +
commons.escapeVariable('$customerId') +
'/schemas/' +
commons.escapeVariable('$schemaKey');
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return Schema.fromJson(response_ as core.Map<core.String, core.dynamic>);
}