Reference documentation and code samples for the Google Cloud Domains V1alpha2 Client class ListRegistrationsRequest.
Request for the ListRegistrations
method.
Generated from protobuf message google.cloud.domains.v1alpha2.ListRegistrationsRequest
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The project and location from which to list |
↳ page_size |
int
Maximum number of results to return. |
↳ page_token |
string
When set to the |
↳ filter |
string
Filter expression to restrict the |
getParent
Required. The project and location from which to list Registration
s, specified in
the format projects/*/locations/*
.
Returns | |
---|---|
Type | Description |
string |
setParent
Required. The project and location from which to list Registration
s, specified in
the format projects/*/locations/*
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
Maximum number of results to return.
Returns | |
---|---|
Type | Description |
int |
setPageSize
Maximum number of results to return.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
When set to the next_page_token
from a prior response, provides the next
page of results.
Returns | |
---|---|
Type | Description |
string |
setPageToken
When set to the next_page_token
from a prior response, provides the next
page of results.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
Filter expression to restrict the Registration
s returned.
The expression must specify the field name, a comparison operator, and the
value that you want to use for filtering. The value must be a string, a
number, a boolean, or an enum value. The comparison operator should be one
of =, !=, >, <, >=, <=, or : for prefix or wildcard matches.
For example, to filter to a specific domain name, use an expression like
domainName="example.com"
. You can also check for the existence of a
field; for example, to find domains using custom DNS settings, use an
expression like dnsSettings.customDns:*
.
You can also create compound filters by combining expressions with the
AND
and OR
operators. For example, to find domains that are suspended
or have specific issues flagged, use an expression like
(state=SUSPENDED) OR (issue:*)
.
Returns | |
---|---|
Type | Description |
string |
setFilter
Filter expression to restrict the Registration
s returned.
The expression must specify the field name, a comparison operator, and the
value that you want to use for filtering. The value must be a string, a
number, a boolean, or an enum value. The comparison operator should be one
of =, !=, >, <, >=, <=, or : for prefix or wildcard matches.
For example, to filter to a specific domain name, use an expression like
domainName="example.com"
. You can also check for the existence of a
field; for example, to find domains using custom DNS settings, use an
expression like dnsSettings.customDns:*
.
You can also create compound filters by combining expressions with the
AND
and OR
operators. For example, to find domains that are suspended
or have specific issues flagged, use an expression like
(state=SUSPENDED) OR (issue:*)
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |