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

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

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

The [ListApiOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method's request.

Inheritance

object > ListApiOperationsRequest

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

ListApiOperationsRequest()

public ListApiOperationsRequest()

ListApiOperationsRequest(ListApiOperationsRequest)

public ListApiOperationsRequest(ListApiOperationsRequest other)
Parameter
Name Description
other ListApiOperationsRequest

Properties

Filter

public string Filter { get; set; }

Optional. An expression that filters the list of ApiOperations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: <, > or =. Filters are not case sensitive.

The following fields in the ApiOperation are eligible for filtering:

  • name - The ApiOperation resource name. Allowed comparison operators: =.
  • details.http_operation.path.path - The http operation's complete path relative to server endpoint. Allowed comparison operators: =.
  • details.http_operation.method - The http operation method type. Allowed comparison operators: =.
  • details.deprecated - Indicates if the ApiOperation is deprecated. Allowed values are True / False indicating the deprycation status of the ApiOperation. Allowed comparison operators: =.
  • create_time - The time at which the ApiOperation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and <.

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.

Here are a few examples:

  • details.deprecated = True - The ApiOperation is deprecated.
  • details.http_operation.method = GET AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The method of the http operation of the ApiOperation is GET and the spec was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.
  • details.http_operation.method = GET OR details.http_operation.method = POST. - The http operation of the method of ApiOperation is GET or POST.
Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

Optional. The maximum number of operations to return. The service may return fewer than this value. If unspecified, at most 50 operations 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 ListApiOperations call. Provide this to retrieve the subsequent page.

When paginating, all other parameters (except page_size) provided to ListApiOperations 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 operations i.e., the API version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

Property Value
Type Description
string

ParentAsVersionName

public VersionName ParentAsVersionName { get; set; }

VersionName-typed view over the Parent resource name property.

Property Value
Type Description
VersionName