Method: projects.locations.dependencies.list

List dependencies based on the provided filter and pagination parameters.

HTTP request

GET https://apihub.googleapis.com/v1/{parent=projects/*/locations/*}/dependencies

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent which owns this collection of dependency resources. Format: projects/{project}/locations/{location}

Query parameters

Parameters
filter

string

Optional. An expression that filters the list of Dependencies.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. Allowed comparison operator is =. Filters are not case sensitive.

The following fields in the Dependency are eligible for filtering:

  • consumer.operation_resource_name - The operation resource name for the consumer entity involved in a dependency. Allowed comparison operators: =.
  • consumer.external_api_resource_name - The external api resource name for the consumer entity involved in a dependency. Allowed comparison operators: =.
  • supplier.operation_resource_name - The operation resource name for the supplier entity involved in a dependency. Allowed comparison operators: =.
  • supplier.external_api_resource_name - The external api resource name for the supplier entity involved in a dependency. Allowed comparison operators: =.

Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API.

For example, consumer.operation_resource_name = \"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\" OR supplier.operation_resource_name = \"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\" - The dependencies with either consumer or supplier operation resource name as projects/p1/locations/global/apis/a1/versions/v1/operations/o1.
pageSize

integer

Optional. The maximum number of dependency resources to return. The service may return fewer than this value. If unspecified, at most 50 dependencies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous dependencies.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to dependencies.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

The dependencies.list method's response.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "dependencies": [
    {
      object (Dependency)
    }
  ],
  "nextPageToken": string
}
Fields
dependencies[]

object (Dependency)

The dependency resources present in the API hub. Only following field will be populated in the response: name.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

IAM Permissions

Requires the following IAM permission on the parent resource:

  • apihub.dependencies.list

For more information, see the IAM documentation.