Class ListHubSpokesRequest.Builder (1.40.0)

public static final class ListHubSpokesRequest.Builder extends GeneratedMessageV3.Builder<ListHubSpokesRequest.Builder> implements ListHubSpokesRequestOrBuilder

The request for HubService.ListHubSpokes.

Protobuf type google.cloud.networkconnectivity.v1.ListHubSpokesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllSpokeLocations(Iterable<String> values)

public ListHubSpokesRequest.Builder addAllSpokeLocations(Iterable<String> values)

A list of locations. Specify one of the following: [global], a single region (for example, [us-central1]), or a combination of values (for example, [global, us-central1, us-west1]). If the spoke_locations field is populated, the list of results includes only spokes in the specified location. If the spoke_locations field is not populated, the list of results includes spokes in all locations.

repeated string spoke_locations = 2;

Parameter
NameDescription
valuesIterable<String>

The spokeLocations to add.

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListHubSpokesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListHubSpokesRequest.Builder
Overrides

addSpokeLocations(String value)

public ListHubSpokesRequest.Builder addSpokeLocations(String value)

A list of locations. Specify one of the following: [global], a single region (for example, [us-central1]), or a combination of values (for example, [global, us-central1, us-west1]). If the spoke_locations field is populated, the list of results includes only spokes in the specified location. If the spoke_locations field is not populated, the list of results includes spokes in all locations.

repeated string spoke_locations = 2;

Parameter
NameDescription
valueString

The spokeLocations to add.

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

addSpokeLocationsBytes(ByteString value)

public ListHubSpokesRequest.Builder addSpokeLocationsBytes(ByteString value)

A list of locations. Specify one of the following: [global], a single region (for example, [us-central1]), or a combination of values (for example, [global, us-central1, us-west1]). If the spoke_locations field is populated, the list of results includes only spokes in the specified location. If the spoke_locations field is not populated, the list of results includes spokes in all locations.

repeated string spoke_locations = 2;

Parameter
NameDescription
valueByteString

The bytes of the spokeLocations to add.

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

build()

public ListHubSpokesRequest build()
Returns
TypeDescription
ListHubSpokesRequest

buildPartial()

public ListHubSpokesRequest buildPartial()
Returns
TypeDescription
ListHubSpokesRequest

clear()

public ListHubSpokesRequest.Builder clear()
Returns
TypeDescription
ListHubSpokesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListHubSpokesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListHubSpokesRequest.Builder
Overrides

clearFilter()

public ListHubSpokesRequest.Builder clearFilter()

An expression that filters the list of results.

string filter = 5;

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

clearName()

public ListHubSpokesRequest.Builder clearName()

Required. The name of the hub.

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

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListHubSpokesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListHubSpokesRequest.Builder
Overrides

clearOrderBy()

public ListHubSpokesRequest.Builder clearOrderBy()

Sort the results by name or create_time.

string order_by = 6;

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

clearPageSize()

public ListHubSpokesRequest.Builder clearPageSize()

The maximum number of results to return per page.

int32 page_size = 3;

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

clearPageToken()

public ListHubSpokesRequest.Builder clearPageToken()

The page token.

string page_token = 4;

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

clearSpokeLocations()

public ListHubSpokesRequest.Builder clearSpokeLocations()

A list of locations. Specify one of the following: [global], a single region (for example, [us-central1]), or a combination of values (for example, [global, us-central1, us-west1]). If the spoke_locations field is populated, the list of results includes only spokes in the specified location. If the spoke_locations field is not populated, the list of results includes spokes in all locations.

repeated string spoke_locations = 2;

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

clearView()

public ListHubSpokesRequest.Builder clearView()

The view of the spoke to return. The view that you use determines which spoke fields are included in the response.

.google.cloud.networkconnectivity.v1.ListHubSpokesRequest.SpokeView view = 7;

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

clone()

public ListHubSpokesRequest.Builder clone()
Returns
TypeDescription
ListHubSpokesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListHubSpokesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListHubSpokesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

An expression that filters the list of results.

string filter = 5;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

An expression that filters the list of results.

string filter = 5;

Returns
TypeDescription
ByteString

The bytes for filter.

getName()

public String getName()

Required. The name of the hub.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the hub.

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

Returns
TypeDescription
ByteString

The bytes for name.

getOrderBy()

public String getOrderBy()

Sort the results by name or create_time.

string order_by = 6;

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Sort the results by name or create_time.

string order_by = 6;

Returns
TypeDescription
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

The maximum number of results to return per page.

int32 page_size = 3;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

The page token.

string page_token = 4;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The page token.

string page_token = 4;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getSpokeLocations(int index)

public String getSpokeLocations(int index)

A list of locations. Specify one of the following: [global], a single region (for example, [us-central1]), or a combination of values (for example, [global, us-central1, us-west1]). If the spoke_locations field is populated, the list of results includes only spokes in the specified location. If the spoke_locations field is not populated, the list of results includes spokes in all locations.

repeated string spoke_locations = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The spokeLocations at the given index.

getSpokeLocationsBytes(int index)

public ByteString getSpokeLocationsBytes(int index)

A list of locations. Specify one of the following: [global], a single region (for example, [us-central1]), or a combination of values (for example, [global, us-central1, us-west1]). If the spoke_locations field is populated, the list of results includes only spokes in the specified location. If the spoke_locations field is not populated, the list of results includes spokes in all locations.

repeated string spoke_locations = 2;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the spokeLocations at the given index.

getSpokeLocationsCount()

public int getSpokeLocationsCount()

A list of locations. Specify one of the following: [global], a single region (for example, [us-central1]), or a combination of values (for example, [global, us-central1, us-west1]). If the spoke_locations field is populated, the list of results includes only spokes in the specified location. If the spoke_locations field is not populated, the list of results includes spokes in all locations.

repeated string spoke_locations = 2;

Returns
TypeDescription
int

The count of spokeLocations.

getSpokeLocationsList()

public ProtocolStringList getSpokeLocationsList()

A list of locations. Specify one of the following: [global], a single region (for example, [us-central1]), or a combination of values (for example, [global, us-central1, us-west1]). If the spoke_locations field is populated, the list of results includes only spokes in the specified location. If the spoke_locations field is not populated, the list of results includes spokes in all locations.

repeated string spoke_locations = 2;

Returns
TypeDescription
ProtocolStringList

A list containing the spokeLocations.

getView()

public ListHubSpokesRequest.SpokeView getView()

The view of the spoke to return. The view that you use determines which spoke fields are included in the response.

.google.cloud.networkconnectivity.v1.ListHubSpokesRequest.SpokeView view = 7;

Returns
TypeDescription
ListHubSpokesRequest.SpokeView

The view.

getViewValue()

public int getViewValue()

The view of the spoke to return. The view that you use determines which spoke fields are included in the response.

.google.cloud.networkconnectivity.v1.ListHubSpokesRequest.SpokeView view = 7;

Returns
TypeDescription
int

The enum numeric value on the wire for view.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListHubSpokesRequest other)

public ListHubSpokesRequest.Builder mergeFrom(ListHubSpokesRequest other)
Parameter
NameDescription
otherListHubSpokesRequest
Returns
TypeDescription
ListHubSpokesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListHubSpokesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListHubSpokesRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListHubSpokesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListHubSpokesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListHubSpokesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListHubSpokesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListHubSpokesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListHubSpokesRequest.Builder
Overrides

setFilter(String value)

public ListHubSpokesRequest.Builder setFilter(String value)

An expression that filters the list of results.

string filter = 5;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListHubSpokesRequest.Builder setFilterBytes(ByteString value)

An expression that filters the list of results.

string filter = 5;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

setName(String value)

public ListHubSpokesRequest.Builder setName(String value)

Required. The name of the hub.

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ListHubSpokesRequest.Builder setNameBytes(ByteString value)

Required. The name of the hub.

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListHubSpokesRequest.Builder setOrderBy(String value)

Sort the results by name or create_time.

string order_by = 6;

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListHubSpokesRequest.Builder setOrderByBytes(ByteString value)

Sort the results by name or create_time.

string order_by = 6;

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListHubSpokesRequest.Builder setPageSize(int value)

The maximum number of results to return per page.

int32 page_size = 3;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListHubSpokesRequest.Builder setPageToken(String value)

The page token.

string page_token = 4;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListHubSpokesRequest.Builder setPageTokenBytes(ByteString value)

The page token.

string page_token = 4;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

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

public ListHubSpokesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListHubSpokesRequest.Builder
Overrides

setSpokeLocations(int index, String value)

public ListHubSpokesRequest.Builder setSpokeLocations(int index, String value)

A list of locations. Specify one of the following: [global], a single region (for example, [us-central1]), or a combination of values (for example, [global, us-central1, us-west1]). If the spoke_locations field is populated, the list of results includes only spokes in the specified location. If the spoke_locations field is not populated, the list of results includes spokes in all locations.

repeated string spoke_locations = 2;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The spokeLocations to set.

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListHubSpokesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListHubSpokesRequest.Builder
Overrides

setView(ListHubSpokesRequest.SpokeView value)

public ListHubSpokesRequest.Builder setView(ListHubSpokesRequest.SpokeView value)

The view of the spoke to return. The view that you use determines which spoke fields are included in the response.

.google.cloud.networkconnectivity.v1.ListHubSpokesRequest.SpokeView view = 7;

Parameter
NameDescription
valueListHubSpokesRequest.SpokeView

The view to set.

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.

setViewValue(int value)

public ListHubSpokesRequest.Builder setViewValue(int value)

The view of the spoke to return. The view that you use determines which spoke fields are included in the response.

.google.cloud.networkconnectivity.v1.ListHubSpokesRequest.SpokeView view = 7;

Parameter
NameDescription
valueint

The enum numeric value on the wire for view to set.

Returns
TypeDescription
ListHubSpokesRequest.Builder

This builder for chaining.