Google Cloud Api Hub V1 Client - Class ListApiOperationsRequest (0.1.3)

Reference documentation and code samples for the Google Cloud Api Hub V1 Client class ListApiOperationsRequest.

The ListApiOperations method's request.

Generated from protobuf message google.cloud.apihub.v1.ListApiOperationsRequest

Namespace

Google \ Cloud \ ApiHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The parent which owns this collection of operations i.e., the API version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}
↳ filter string

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.
↳ page_size int

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.
↳ page_token string

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.

getParent

Required. The parent which owns this collection of operations i.e., the API version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

Returns
Type Description
string

setParent

Required. The parent which owns this collection of operations i.e., the API version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

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.
Returns
Type Description
string

setFilter

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.
Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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.

Returns
Type Description
int

setPageSize

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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.

Returns
Type Description
string

setPageToken

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.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent which owns this collection of operations i.e., the API version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version} Please see ApiHubClient::versionName() for help formatting this field.
Returns
Type Description
ListApiOperationsRequest