Class SearchCloudLocationsRequest.Builder (0.1.0) 

public static final class SearchCloudLocationsRequest.Builder extends GeneratedMessageV3.Builder<SearchCloudLocationsRequest.Builder> implements SearchCloudLocationsRequestOrBuilder

Message for searching cloud locations from a given source location.

Protobuf type google.cloud.locationfinder.v1.SearchCloudLocationsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchCloudLocationsRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchCloudLocationsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchCloudLocationsRequest.Builder
Overrides

build()

public SearchCloudLocationsRequest build()
Returns
Type Description
SearchCloudLocationsRequest

buildPartial()

public SearchCloudLocationsRequest buildPartial()
Returns
Type Description
SearchCloudLocationsRequest

clear()

public SearchCloudLocationsRequest.Builder clear()
Returns
Type Description
SearchCloudLocationsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchCloudLocationsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SearchCloudLocationsRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchCloudLocationsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SearchCloudLocationsRequest.Builder
Overrides

clearPageSize()

public SearchCloudLocationsRequest.Builder clearPageSize()

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.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchCloudLocationsRequest.Builder

This builder for chaining.

clearPageToken()

public SearchCloudLocationsRequest.Builder clearPageToken()

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.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchCloudLocationsRequest.Builder

This builder for chaining.

clearParent()

public SearchCloudLocationsRequest.Builder clearParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
SearchCloudLocationsRequest.Builder

This builder for chaining.

clearQuery()

public SearchCloudLocationsRequest.Builder clearQuery()

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.

string query = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchCloudLocationsRequest.Builder

This builder for chaining.

clearSourceCloudLocation()

public SearchCloudLocationsRequest.Builder clearSourceCloudLocation()

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

string source_cloud_location = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
SearchCloudLocationsRequest.Builder

This builder for chaining.

clone()

public SearchCloudLocationsRequest.Builder clone()
Returns
Type Description
SearchCloudLocationsRequest.Builder
Overrides

getDefaultInstanceForType()

public SearchCloudLocationsRequest getDefaultInstanceForType()
Returns
Type Description
SearchCloudLocationsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPageSize()

public int 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.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String 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.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getQuery()

public String 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.

string query = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The query.

getQueryBytes()

public ByteString getQueryBytes()

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.

string query = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for query.

getSourceCloudLocation()

public String getSourceCloudLocation()

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

string source_cloud_location = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The sourceCloudLocation.

getSourceCloudLocationBytes()

public ByteString getSourceCloudLocationBytes()

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

string source_cloud_location = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for sourceCloudLocation.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchCloudLocationsRequest other)

public SearchCloudLocationsRequest.Builder mergeFrom(SearchCloudLocationsRequest other)
Parameter
Name Description
other SearchCloudLocationsRequest
Returns
Type Description
SearchCloudLocationsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchCloudLocationsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchCloudLocationsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchCloudLocationsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchCloudLocationsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchCloudLocationsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchCloudLocationsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchCloudLocationsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchCloudLocationsRequest.Builder
Overrides

setPageSize(int value)

public SearchCloudLocationsRequest.Builder setPageSize(int value)

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.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
SearchCloudLocationsRequest.Builder

This builder for chaining.

setPageToken(String value)

public SearchCloudLocationsRequest.Builder setPageToken(String value)

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.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
SearchCloudLocationsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchCloudLocationsRequest.Builder setPageTokenBytes(ByteString value)

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.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
SearchCloudLocationsRequest.Builder

This builder for chaining.

setParent(String value)

public SearchCloudLocationsRequest.Builder setParent(String value)

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
SearchCloudLocationsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public SearchCloudLocationsRequest.Builder setParentBytes(ByteString value)

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
SearchCloudLocationsRequest.Builder

This builder for chaining.

setQuery(String value)

public SearchCloudLocationsRequest.Builder setQuery(String value)

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.

string query = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The query to set.
Returns
Type Description
SearchCloudLocationsRequest.Builder

This builder for chaining.

setQueryBytes(ByteString value)

public SearchCloudLocationsRequest.Builder setQueryBytes(ByteString value)

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.

string query = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for query to set.
Returns
Type Description
SearchCloudLocationsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchCloudLocationsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SearchCloudLocationsRequest.Builder
Overrides

setSourceCloudLocation(String value)

public SearchCloudLocationsRequest.Builder setSourceCloudLocation(String value)

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

string source_cloud_location = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The sourceCloudLocation to set.
Returns
Type Description
SearchCloudLocationsRequest.Builder

This builder for chaining.

setSourceCloudLocationBytes(ByteString value)

public SearchCloudLocationsRequest.Builder setSourceCloudLocationBytes(ByteString value)

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

string source_cloud_location = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for sourceCloudLocation to set.
Returns
Type Description
SearchCloudLocationsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchCloudLocationsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchCloudLocationsRequest.Builder
Overrides