getDeployedIngressConfig method

Future<GoogleCloudApigeeV1IngressConfig> getDeployedIngressConfig(
  1. String name, {
  2. String? view,
  3. String? $fields,
})

Gets the deployed ingress configuration for an organization.

Request parameters:

name - Required. Name of the deployed configuration for the organization in the following format: 'organizations/{org}/deployedIngressConfig'. Value must have pattern ^organizations/\[^/\]+/deployedIngressConfig$.

view - When set to FULL, additional details about the specific deployments receiving traffic will be included in the IngressConfig response's RoutingRules. Possible string values are:

  • "INGRESS_CONFIG_VIEW_UNSPECIFIED" : The default/unset value. The API will default to the BASIC view.
  • "BASIC" : Include all ingress config data necessary for the runtime to configure ingress, but no more. Routing rules will include only basepath and destination environment. This the default value.
  • "FULL" : Include all ingress config data, including internal debug info for each routing rule such as the proxy claiming a particular basepath and when the routing rule first appeared in the env group.

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

Completes with a GoogleCloudApigeeV1IngressConfig.

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<GoogleCloudApigeeV1IngressConfig> getDeployedIngressConfig(
  core.String name, {
  core.String? view,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (view != null) 'view': [view],
    if ($fields != null) 'fields': [$fields],
  };

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

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