authorizeAccess method

Future<GoogleProtobufEmpty> authorizeAccess(
  1. GoogleCloudAiplatformV1AuthorizeSandboxEnvironmentAccessRequest request,
  2. String name, {
  3. String? $fields,
})

Checks whether the caller is authorized to access the sandbox environment.

Authorization is performed entirely by the API infrastructure from the method_policy below; the handler is a no-op. A successful response means the caller holds sandboxEnvironments.execute on the named sandbox. Used by the sandbox data-plane proxy, which forwards the caller's credential and proxies traffic only on success.

request - The metadata request object.

Request parameters:

name - Required. The resource name of the sandbox environment to authorize access to. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment} Value must have pattern ^reasoningEngines/\[^/\]+/sandboxEnvironments/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleCloudAiplatformV1AuthorizeSandboxEnvironmentAccessResponse.

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<GoogleCloudAiplatformV1AuthorizeSandboxEnvironmentAccessResponse>
authorizeAccess(
  GoogleCloudAiplatformV1AuthorizeSandboxEnvironmentAccessRequest request,
  core.String name, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name') + ':authorizeAccess';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return GoogleCloudAiplatformV1AuthorizeSandboxEnvironmentAccessResponse.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}