Google Cloud Api Hub V1 Client - Class ListHostProjectRegistrationsRequest (0.1.1)

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

The ListHostProjectRegistrations method's request.

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

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 host projects. Format: projects/*/locations/*
↳ page_size int

Optional. The maximum number of host project registrations to return. The service may return fewer than this value. If unspecified, at most 50 host project registrations 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 ListHostProjectRegistrations call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to ListHostProjectRegistrations must match the call that provided the page token.
↳ filter string

Optional. An expression that filters the list of HostProjectRegistrations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the HostProjectRegistration are eligible for filtering: * name - The name of the HostProjectRegistration. * create_time - The time at which the HostProjectRegistration was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. * gcp_project - The Google cloud project associated with the HostProjectRegistration.
↳ order_by string

Optional. Hint for how to order the results.

getParent

Required. The parent, which owns this collection of host projects.

Format: projects/*/locations/*

Returns
Type Description
string

setParent

Required. The parent, which owns this collection of host projects.

Format: projects/*/locations/*

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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

When paginating, all other parameters (except page_size) provided to ListHostProjectRegistrations must match the call that provided the page token.

Returns
Type Description
string

setPageToken

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

When paginating, all other parameters (except page_size) provided to ListHostProjectRegistrations must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. An expression that filters the list of HostProjectRegistrations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the HostProjectRegistration are eligible for filtering:

  • name - The name of the HostProjectRegistration.
  • create_time - The time at which the HostProjectRegistration was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format.
  • gcp_project - The Google cloud project associated with the HostProjectRegistration.
Returns
Type Description
string

setFilter

Optional. An expression that filters the list of HostProjectRegistrations.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the HostProjectRegistration are eligible for filtering:

  • name - The name of the HostProjectRegistration.
  • create_time - The time at which the HostProjectRegistration was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format.
  • gcp_project - The Google cloud project associated with the HostProjectRegistration.
Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. Hint for how to order the results.

Returns
Type Description
string

setOrderBy

Optional. Hint for how to order the results.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent, which owns this collection of host projects. Format: projects/*/locations/* Please see Google\Cloud\ApiHub\V1\HostProjectRegistrationServiceClient::locationName() for help formatting this field.
Returns
Type Description
Google\Cloud\ApiHub\V1\ListHostProjectRegistrationsRequest