- 1.86.0 (latest)
- 1.85.0
- 1.84.0
- 1.83.0
- 1.82.0
- 1.80.0
- 1.78.0
- 1.77.0
- 1.74.0
- 1.73.0
- 1.72.0
- 1.70.0
- 1.69.0
- 1.68.0
- 1.67.0
- 1.66.0
- 1.65.0
- 1.64.0
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public final class ListGlobalAddressesRequest extends GeneratedMessageV3 implements ListGlobalAddressesRequestOrBuilderA request message for GlobalAddresses.List. See the method description for details.
Protobuf type google.cloud.compute.v1.ListGlobalAddressesRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListGlobalAddressesRequestImplements
ListGlobalAddressesRequestOrBuilderStatic Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MAX_RESULTS_FIELD_NUMBER
public static final int MAX_RESULTS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PROJECT_FIELD_NUMBER
public static final int PROJECT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RETURN_PARTIAL_SUCCESS_FIELD_NUMBER
public static final int RETURN_PARTIAL_SUCCESS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static ListGlobalAddressesRequest getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static ListGlobalAddressesRequest.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest.Builder |
|
newBuilder(ListGlobalAddressesRequest prototype)
public static ListGlobalAddressesRequest.Builder newBuilder(ListGlobalAddressesRequest prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
ListGlobalAddressesRequest |
| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest.Builder |
|
parseDelimitedFrom(InputStream input)
public static ListGlobalAddressesRequest parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListGlobalAddressesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static ListGlobalAddressesRequest parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListGlobalAddressesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static ListGlobalAddressesRequest parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListGlobalAddressesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static ListGlobalAddressesRequest parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListGlobalAddressesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static ListGlobalAddressesRequest parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListGlobalAddressesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static ListGlobalAddressesRequest parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListGlobalAddressesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<ListGlobalAddressesRequest> parser()| Returns | |
|---|---|
| Type | Description |
Parser<ListGlobalAddressesRequest> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public ListGlobalAddressesRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest |
|
getFilter()
public String getFilter()A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.
If you want to use AIP-160, your expression must specify the field name, an
operator, and the value that you want to use for filtering. The value
must be a string, a number, or a boolean. The 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.
The : comparison can be used to test whether a key has been defined.
For example, to find all objects with owner label use:
`
labels.owner:
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 onresource labels.
To filter on multiple expressions, provide each separate expression within
parentheses. For example:
(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")
By default, each expression is an AND expression. However, you
can include AND and OR expressions explicitly.
For example:
(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)
If you want to use a regular expression, use the eq (equal) or ne
(not equal) operator against a single un-parenthesized expression with or
without quotes or against multiple parenthesized expressions. Examples:
fieldname eq unquoted literal
fieldname eq 'single quoted literal'
fieldname eq "double quoted literal"
(fieldname1 eq literal) (fieldname2 ne "literal")
The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
The literal value must match the entire field.
For example, to filter for instances that do not end with name "instance",
you would use name ne .*instance`.
You cannot combine constraints on multiple fields using regular expressions.
optional string filter = 336120696;
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes()A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.
If you want to use AIP-160, your expression must specify the field name, an
operator, and the value that you want to use for filtering. The value
must be a string, a number, or a boolean. The 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.
The : comparison can be used to test whether a key has been defined.
For example, to find all objects with owner label use:
`
labels.owner:
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 onresource labels.
To filter on multiple expressions, provide each separate expression within
parentheses. For example:
(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")
By default, each expression is an AND expression. However, you
can include AND and OR expressions explicitly.
For example:
(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)
If you want to use a regular expression, use the eq (equal) or ne
(not equal) operator against a single un-parenthesized expression with or
without quotes or against multiple parenthesized expressions. Examples:
fieldname eq unquoted literal
fieldname eq 'single quoted literal'
fieldname eq "double quoted literal"
(fieldname1 eq literal) (fieldname2 ne "literal")
The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
The literal value must match the entire field.
For example, to filter for instances that do not end with name "instance",
you would use name ne .*instance`.
You cannot combine constraints on multiple fields using regular expressions.
optional string filter = 336120696;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
getParserForType()
public Parser<ListGlobalAddressesRequest> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<ListGlobalAddressesRequest> |
|
getProject()
public String getProject()Project ID for this request.
string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The project. |
getProjectBytes()
public ByteString getProjectBytes()Project ID for this request.
string project = 227560217 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
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.
For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
optional bool return_partial_success = 517198390;
| Returns | |
|---|---|
| Type | Description |
boolean |
The returnPartialSuccess. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hasFilter()
public boolean hasFilter()A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request.
If you want to use AIP-160, your expression must specify the field name, an
operator, and the value that you want to use for filtering. The value
must be a string, a number, or a boolean. The 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.
The : comparison can be used to test whether a key has been defined.
For example, to find all objects with owner label use:
`
labels.owner:
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 onresource labels.
To filter on multiple expressions, provide each separate expression within
parentheses. For example:
(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")
By default, each expression is an AND expression. However, you
can include AND and OR expressions explicitly.
For example:
(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)
If you want to use a regular expression, use the eq (equal) or ne
(not equal) operator against a single un-parenthesized expression with or
without quotes or against multiple parenthesized expressions. Examples:
fieldname eq unquoted literal
fieldname eq 'single quoted literal'
fieldname eq "double quoted literal"
(fieldname1 eq literal) (fieldname2 ne "literal")
The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
The literal value must match the entire field.
For example, to filter for instances that do not end with name "instance",
you would use name ne .*instance`.
You cannot combine constraints on multiple fields using regular expressions.
optional string filter = 336120696;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the filter 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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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.
For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
optional bool return_partial_success = 517198390;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the returnPartialSuccess field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public ListGlobalAddressesRequest.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListGlobalAddressesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public ListGlobalAddressesRequest.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
ListGlobalAddressesRequest.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|