public interface ListNamespacesRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getFilter()
public abstract String getFilter()
Optional. The filter to list results by.
General filter
string syntax:
<field> <operator> <value> (<logical connector>)
<field>
can bename
,labels.<key>
for map field, orattributes.<field>
for attributes field<operator>
can be<
,>
,<=
,>=
,!=
,=
,:
. Of which:
meansHAS
, and is roughly the same as=
<value>
must be the same data type as field<logical connector>
can beAND
,OR
,NOT
Examples of valid filters:
labels.owner
returns namespaces that have a label with the keyowner
, this is the same aslabels:owner
labels.owner=sd
returns namespaces that have key/valueowner=sd
name>projects/my-project/locations/us-east1/namespaces/namespace-c
returns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is notlabels.owner!=sd AND labels.foo=bar
returns namespaces that haveowner
in label key but value is notsd
AND have key/valuefoo=bar
doesnotexist.foo=bar
returns an empty list. Note that namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no resultsattributes.managed_registration=true
returns namespaces that are managed by a GCP product or serviceFor more information about filtering, see API Filtering.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The filter. |
getFilterBytes()
public abstract ByteString getFilterBytes()
Optional. The filter to list results by.
General filter
string syntax:
<field> <operator> <value> (<logical connector>)
<field>
can bename
,labels.<key>
for map field, orattributes.<field>
for attributes field<operator>
can be<
,>
,<=
,>=
,!=
,=
,:
. Of which:
meansHAS
, and is roughly the same as=
<value>
must be the same data type as field<logical connector>
can beAND
,OR
,NOT
Examples of valid filters:
labels.owner
returns namespaces that have a label with the keyowner
, this is the same aslabels:owner
labels.owner=sd
returns namespaces that have key/valueowner=sd
name>projects/my-project/locations/us-east1/namespaces/namespace-c
returns namespaces that have name that is alphabetically later than the string, so "namespace-e" is returned but "namespace-a" is notlabels.owner!=sd AND labels.foo=bar
returns namespaces that haveowner
in label key but value is notsd
AND have key/valuefoo=bar
doesnotexist.foo=bar
returns an empty list. Note that namespace doesn't have a field called "doesnotexist". Since the filter does not match any namespaces, it returns no resultsattributes.managed_registration=true
returns namespaces that are managed by a GCP product or serviceFor more information about filtering, see API Filtering.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for filter. |
getOrderBy()
public abstract String getOrderBy()
Optional. The order to list results by.
General order_by
string syntax: <field> (<asc|desc>) (,)
<field>
allows value:name
<asc|desc>
ascending or descending order by<field>
. If this is left blank,asc
is usedNote that an empty
order_by
string results in default order, which is order byname
in ascending order.
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The orderBy. |
getOrderByBytes()
public abstract ByteString getOrderByBytes()
Optional. The order to list results by.
General order_by
string syntax: <field> (<asc|desc>) (,)
<field>
allows value:name
<asc|desc>
ascending or descending order by<field>
. If this is left blank,asc
is usedNote that an empty
order_by
string results in default order, which is order byname
in ascending order.
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for orderBy. |
getPageSize()
public abstract int getPageSize()
Optional. The maximum number of items to return. The default value is 100.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The pageSize. |
getPageToken()
public abstract String getPageToken()
Optional. The next_page_token value returned from a previous List request, if any.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public abstract ByteString getPageTokenBytes()
Optional. The next_page_token value returned from a previous List request, if any.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for pageToken. |
getParent()
public abstract String getParent()
Required. The resource name of the project and location whose namespaces you'd like to list.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The parent. |
getParentBytes()
public abstract ByteString getParentBytes()
Required. The resource name of the project and location whose namespaces you'd like to list.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for parent. |