Reference documentation and code samples for the Google Cloud Location Finder V1 Client class SearchCloudLocationsRequest.
Message for searching cloud locations from a given source location.
Generated from protobuf message google.cloud.locationfinder.v1.SearchCloudLocationsRequest
Namespace
Google \ Cloud \ LocationFinder \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location} |
↳ source_cloud_location |
string
Required. The source cloud location to search from. Example search can be searching nearby cloud locations from the source cloud location by latency. |
↳ page_size |
int
Optional. The maximum number of cloud locations to return. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default. |
↳ page_token |
string
Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token. |
↳ query |
string
Optional. The query string in search query syntax. While filter is used to filter the search results by attributes, query is used to specify the search requirements. |
getParent
Required. The parent, which owns this collection of cloud locations.
Format: projects/{project}/locations/{location}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent, which owns this collection of cloud locations.
Format: projects/{project}/locations/{location}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSourceCloudLocation
Required. The source cloud location to search from.
Example search can be searching nearby cloud locations from the source cloud location by latency.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSourceCloudLocation
Required. The source cloud location to search from.
Example search can be searching nearby cloud locations from the source cloud location by latency.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. The maximum number of cloud locations to return. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. The maximum number of cloud locations to return. The service might return fewer cloud locations than this value. If unspecified, server will pick an appropriate default.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. A token identifying a page of results the server should return.
Provide Page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A token identifying a page of results the server should return.
Provide Page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuery
Optional. The query string in search query syntax. While filter is used to filter the search results by attributes, query is used to specify the search requirements.
| Returns | |
|---|---|
| Type | Description |
string |
|
setQuery
Optional. The query string in search query syntax. While filter is used to filter the search results by attributes, query is used to specify the search requirements.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location} Please see CloudLocationFinderClient::locationName() for help formatting this field. |
sourceCloudLocation |
string
Required. The source cloud location to search from. Example search can be searching nearby cloud locations from the source cloud location by latency. Please see CloudLocationFinderClient::cloudLocationName() for help formatting this field. |
query |
string
Optional. The query string in search query syntax. While filter is used to filter the search results by attributes, query is used to specify the search requirements. |
| Returns | |
|---|---|
| Type | Description |
SearchCloudLocationsRequest |
|