Class ListAgentGatewaysRequest.Builder (0.51.0)

public static final class ListAgentGatewaysRequest.Builder extends GeneratedMessage.Builder<ListAgentGatewaysRequest.Builder> implements ListAgentGatewaysRequestOrBuilder

Request used with the ListAgentGateways method.

Protobuf type google.cloud.networkservices.v1.ListAgentGatewaysRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListAgentGatewaysRequest build()
Returns
Type Description
ListAgentGatewaysRequest

buildPartial()

public ListAgentGatewaysRequest buildPartial()
Returns
Type Description
ListAgentGatewaysRequest

clear()

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

clearPageSize()

public ListAgentGatewaysRequest.Builder clearPageSize()

Optional. Maximum number of AgentGateways to return per call.

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

Returns
Type Description
ListAgentGatewaysRequest.Builder

This builder for chaining.

clearPageToken()

public ListAgentGatewaysRequest.Builder clearPageToken()

Optional. The value returned by the last ListAgentGatewaysResponse Indicates that this is a continuation of a prior ListAgentGateways call, and that the system should return the next page of data.

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

Returns
Type Description
ListAgentGatewaysRequest.Builder

This builder for chaining.

clearParent()

public ListAgentGatewaysRequest.Builder clearParent()

Required. The project and location from which the AgentGateways should be listed, specified in the format projects/*/locations/*.

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

Returns
Type Description
ListAgentGatewaysRequest.Builder

This builder for chaining.

clearReturnPartialSuccess()

public ListAgentGatewaysRequest.Builder clearReturnPartialSuccess()

Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.

bool return_partial_success = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListAgentGatewaysRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListAgentGatewaysRequest getDefaultInstanceForType()
Returns
Type Description
ListAgentGatewaysRequest

getDescriptorForType()

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

getPageSize()

public int getPageSize()

Optional. Maximum number of AgentGateways to return per call.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. The value returned by the last ListAgentGatewaysResponse Indicates that this is a continuation of a prior ListAgentGateways call, and that the system should return the next page of data.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The value returned by the last ListAgentGatewaysResponse Indicates that this is a continuation of a prior ListAgentGateways call, and that the system should return the next page of data.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The project and location from which the AgentGateways should be listed, specified in the format projects/*/locations/*.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The project and location from which the AgentGateways should be listed, specified in the format projects/*/locations/*.

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

Returns
Type Description
ByteString

The bytes for parent.

getReturnPartialSuccess()

public boolean getReturnPartialSuccess()

Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.

bool return_partial_success = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The returnPartialSuccess.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListAgentGatewaysRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setPageSize(int value)

public ListAgentGatewaysRequest.Builder setPageSize(int value)

Optional. Maximum number of AgentGateways to return per call.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListAgentGatewaysRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListAgentGatewaysRequest.Builder setPageToken(String value)

Optional. The value returned by the last ListAgentGatewaysResponse Indicates that this is a continuation of a prior ListAgentGateways call, and that the system should return the next page of data.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListAgentGatewaysRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListAgentGatewaysRequest.Builder setPageTokenBytes(ByteString value)

Optional. The value returned by the last ListAgentGatewaysResponse Indicates that this is a continuation of a prior ListAgentGateways call, and that the system should return the next page of data.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListAgentGatewaysRequest.Builder

This builder for chaining.

setParent(String value)

public ListAgentGatewaysRequest.Builder setParent(String value)

Required. The project and location from which the AgentGateways should be listed, specified in the format projects/*/locations/*.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListAgentGatewaysRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListAgentGatewaysRequest.Builder setParentBytes(ByteString value)

Required. The project and location from which the AgentGateways should be listed, specified in the format projects/*/locations/*.

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
ListAgentGatewaysRequest.Builder

This builder for chaining.

setReturnPartialSuccess(boolean value)

public ListAgentGatewaysRequest.Builder setReturnPartialSuccess(boolean value)

Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.

bool return_partial_success = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The returnPartialSuccess to set.

Returns
Type Description
ListAgentGatewaysRequest.Builder

This builder for chaining.