list method

Future<ListFloodlightActivitiesResponse> list(
  1. String floodlightGroupId, {
  2. String? orderBy,
  3. int? pageSize,
  4. String? pageToken,
  5. String? partnerId,
  6. String? $fields,
})

Lists Floodlight activities in a Floodlight group.

Request parameters:

floodlightGroupId - Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong. Value must have pattern ^\[^/\]+$.

orderBy - Optional. Field by which to sort the list. Acceptable values are: * displayName (default) * floodlightActivityId The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

pageSize - Optional. Requested page size. Must be between 1 and 200. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

pageToken - Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListFloodlightActivities method. If not specified, the first page of results will be returned.

partnerId - Required. The ID of the partner through which the Floodlight activities are being accessed.

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

Completes with a ListFloodlightActivitiesResponse.

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<ListFloodlightActivitiesResponse> list(
  core.String floodlightGroupId, {
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.String? partnerId,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'orderBy': ?orderBy == null ? null : [orderBy],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'partnerId': ?partnerId == null ? null : [partnerId],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ =
      'v2/floodlightGroups/' +
      core.Uri.encodeFull('$floodlightGroupId') +
      '/floodlightActivities';

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