Class AggregatedListVpnGatewaysRequest.Builder (1.6.0-beta)

public static final class AggregatedListVpnGatewaysRequest.Builder extends GeneratedMessageV3.Builder<AggregatedListVpnGatewaysRequest.Builder> implements AggregatedListVpnGatewaysRequestOrBuilder

A request message for VpnGateways.AggregatedList. See the method description for details.

Protobuf type google.cloud.compute.v1.AggregatedListVpnGatewaysRequest

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public AggregatedListVpnGatewaysRequest build()
Returns
TypeDescription
AggregatedListVpnGatewaysRequest

buildPartial()

public AggregatedListVpnGatewaysRequest buildPartial()
Returns
TypeDescription
AggregatedListVpnGatewaysRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public AggregatedListVpnGatewaysRequest.Builder clearFilter()

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: <code><code> (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) </code></code>

optional string filter = 336120696;

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

clearIncludeAllScopes()

public AggregatedListVpnGatewaysRequest.Builder clearIncludeAllScopes()

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

optional bool include_all_scopes = 391327988;

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

clearMaxResults()

public AggregatedListVpnGatewaysRequest.Builder clearMaxResults()

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

optional uint32 max_results = 54715419;

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public AggregatedListVpnGatewaysRequest.Builder clearOrderBy()

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

optional string order_by = 160562920;

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

clearPageToken()

public AggregatedListVpnGatewaysRequest.Builder clearPageToken()

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

optional string page_token = 19994697;

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

clearProject()

public AggregatedListVpnGatewaysRequest.Builder clearProject()

Project ID for this request.

string project = 227560217 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

clearReturnPartialSuccess()

public AggregatedListVpnGatewaysRequest.Builder clearReturnPartialSuccess()

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

optional bool return_partial_success = 517198390;

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public AggregatedListVpnGatewaysRequest getDefaultInstanceForType()
Returns
TypeDescription
AggregatedListVpnGatewaysRequest

getDescriptor()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: <code><code> (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) </code></code>

optional string filter = 336120696;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: <code><code> (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) </code></code>

optional string filter = 336120696;

Returns
TypeDescription
ByteString

The bytes for filter.

getIncludeAllScopes()

public boolean getIncludeAllScopes()

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

optional bool include_all_scopes = 391327988;

Returns
TypeDescription
boolean

The includeAllScopes.

getMaxResults()

public int getMaxResults()

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

optional uint32 max_results = 54715419;

Returns
TypeDescription
int

The maxResults.

getOrderBy()

public String getOrderBy()

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

optional string order_by = 160562920;

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

optional string order_by = 160562920;

Returns
TypeDescription
ByteString

The bytes for orderBy.

getPageToken()

public String getPageToken()

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

optional string page_token = 19994697;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

optional string page_token = 19994697;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getProject()

public String getProject()

Project ID for this request.

string project = 227560217 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The project.

getProjectBytes()

public ByteString getProjectBytes()

Project ID for this request.

string project = 227560217 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for project.

getReturnPartialSuccess()

public boolean getReturnPartialSuccess()

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

optional bool return_partial_success = 517198390;

Returns
TypeDescription
boolean

The returnPartialSuccess.

hasFilter()

public boolean hasFilter()

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: <code><code> (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) </code></code>

optional string filter = 336120696;

Returns
TypeDescription
boolean

Whether the filter field is set.

hasIncludeAllScopes()

public boolean hasIncludeAllScopes()

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

optional bool include_all_scopes = 391327988;

Returns
TypeDescription
boolean

Whether the includeAllScopes field is set.

hasMaxResults()

public boolean hasMaxResults()

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

optional uint32 max_results = 54715419;

Returns
TypeDescription
boolean

Whether the maxResults field is set.

hasOrderBy()

public boolean hasOrderBy()

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

optional string order_by = 160562920;

Returns
TypeDescription
boolean

Whether the orderBy field is set.

hasPageToken()

public boolean hasPageToken()

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

optional string page_token = 19994697;

Returns
TypeDescription
boolean

Whether the pageToken field is set.

hasReturnPartialSuccess()

public boolean hasReturnPartialSuccess()

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

optional bool return_partial_success = 517198390;

Returns
TypeDescription
boolean

Whether the returnPartialSuccess field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(AggregatedListVpnGatewaysRequest other)

public AggregatedListVpnGatewaysRequest.Builder mergeFrom(AggregatedListVpnGatewaysRequest other)
Parameter
NameDescription
otherAggregatedListVpnGatewaysRequest
Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public AggregatedListVpnGatewaysRequest.Builder setFilter(String value)

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: <code><code> (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) </code></code>

optional string filter = 336120696;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public AggregatedListVpnGatewaysRequest.Builder setFilterBytes(ByteString value)

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: <code><code> (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") </code></code><code> By default, each expression is an </code>AND<code> expression. However, you can include </code>AND<code> and </code>OR<code> expressions explicitly. For example: </code><code><code> (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) </code></code>

optional string filter = 336120696;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

setIncludeAllScopes(boolean value)

public AggregatedListVpnGatewaysRequest.Builder setIncludeAllScopes(boolean value)

Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

optional bool include_all_scopes = 391327988;

Parameter
NameDescription
valueboolean

The includeAllScopes to set.

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

setMaxResults(int value)

public AggregatedListVpnGatewaysRequest.Builder setMaxResults(int value)

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

optional uint32 max_results = 54715419;

Parameter
NameDescription
valueint

The maxResults to set.

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

setOrderBy(String value)

public AggregatedListVpnGatewaysRequest.Builder setOrderBy(String value)

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

optional string order_by = 160562920;

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public AggregatedListVpnGatewaysRequest.Builder setOrderByBytes(ByteString value)

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

optional string order_by = 160562920;

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

setPageToken(String value)

public AggregatedListVpnGatewaysRequest.Builder setPageToken(String value)

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

optional string page_token = 19994697;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public AggregatedListVpnGatewaysRequest.Builder setPageTokenBytes(ByteString value)

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

optional string page_token = 19994697;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

setProject(String value)

public AggregatedListVpnGatewaysRequest.Builder setProject(String value)

Project ID for this request.

string project = 227560217 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The project to set.

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

setProjectBytes(ByteString value)

public AggregatedListVpnGatewaysRequest.Builder setProjectBytes(ByteString value)

Project ID for this request.

string project = 227560217 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for project to set.

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

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

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

setReturnPartialSuccess(boolean value)

public AggregatedListVpnGatewaysRequest.Builder setReturnPartialSuccess(boolean value)

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

optional bool return_partial_success = 517198390;

Parameter
NameDescription
valueboolean

The returnPartialSuccess to set.

Returns
TypeDescription
AggregatedListVpnGatewaysRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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