API hub v1 API - Class ListDependenciesRequest (1.0.0-beta02) 

public sealed class ListDependenciesRequest : IPageRequest, IMessage<ListDependenciesRequest>, IEquatable<ListDependenciesRequest>, IDeepCloneable<ListDependenciesRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the API hub v1 API class ListDependenciesRequest.

The [ListDependencies][google.cloud.apihub.v1.ApiHubDependencies.ListDependencies] method's request.

Inheritance

object > ListDependenciesRequest

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

ListDependenciesRequest()

public ListDependenciesRequest()

ListDependenciesRequest(ListDependenciesRequest)

public ListDependenciesRequest(ListDependenciesRequest other)
Parameter
Name Description
other ListDependenciesRequest

Properties

Filter

public string Filter { get; set; }

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.

Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

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.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

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

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

Property Value
Type Description
string

Parent

public string Parent { get; set; }

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

Property Value
Type Description
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type Description
LocationName