Cloud Location Finder v1 API - Class SearchCloudLocationsRequest (1.0.0-beta01)

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

Reference documentation and code samples for the Cloud Location Finder v1 API class SearchCloudLocationsRequest.

Message for searching cloud locations from a given source location.

Inheritance

object > SearchCloudLocationsRequest

Namespace

Google.Cloud.LocationFinder.V1

Assembly

Google.Cloud.LocationFinder.V1.dll

Constructors

SearchCloudLocationsRequest()

public SearchCloudLocationsRequest()

SearchCloudLocationsRequest(SearchCloudLocationsRequest)

public SearchCloudLocationsRequest(SearchCloudLocationsRequest other)
Parameter
Name Description
other SearchCloudLocationsRequest

Properties

PageSize

public int PageSize { get; set; }

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.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

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.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location}

Property Value
Type Description
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type Description
LocationName

Query

public string Query { get; set; }

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.

Property Value
Type Description
string

SourceCloudLocation

public string SourceCloudLocation { get; set; }

Required. The source cloud location to search from. Example search can be searching nearby cloud locations from the source cloud location by latency.

Property Value
Type Description
string

SourceCloudLocationAsCloudLocationName

public CloudLocationName SourceCloudLocationAsCloudLocationName { get; set; }

CloudLocationName-typed view over the SourceCloudLocation resource name property.

Property Value
Type Description
CloudLocationName