Interface ListInstancesRequestOrBuilder (6.74.1)

Version 6.74.1

• 6.83.0 (latest)
• 6.82.0
• 6.80.1
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

public interface ListInstancesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

• name
• display_name

• labels.key where key is the name of a label

  Some examples of using filters are:

• name:* --> The instance has a name.

• name:Howl --> The instance's name contains the string "howl".
• name:HOWL --> Equivalent to above.
• NAME:howl --> Equivalent to above.
• labels.env:* --> The instance has the label "env".
• labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev".
• name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".

string filter = 4;

Returns
Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

• name
• display_name

• labels.key where key is the name of a label

  Some examples of using filters are:

• name:* --> The instance has a name.

• name:Howl --> The instance's name contains the string "howl".
• name:HOWL --> Equivalent to above.
• NAME:howl --> Equivalent to above.
• labels.env:* --> The instance has the label "env".
• labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev".
• name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".

string filter = 4;

Returns
Type	Description
ByteString	The bytes for filter.

getInstanceDeadline()

public abstract Timestamp getInstanceDeadline()

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

.google.protobuf.Timestamp instance_deadline = 5;

Returns
Type	Description
Timestamp	The instanceDeadline.

getInstanceDeadlineOrBuilder()

public abstract TimestampOrBuilder getInstanceDeadlineOrBuilder()

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

.google.protobuf.Timestamp instance_deadline = 5;

Returns
Type	Description
TimestampOrBuilder

getPageSize()

public abstract int getPageSize()

Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

int32 page_size = 2;

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

If non-empty, page_token should contain a next_page_token from a previous ListInstancesResponse.

string page_token = 3;

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

If non-empty, page_token should contain a next_page_token from a previous ListInstancesResponse.

string page_token = 3;

Returns
Type	Description
ByteString	The bytes for pageToken.

getParent()

public abstract String getParent()

Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.

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 name of the project for which a list of instances is requested. Values are of the form projects/<project>.

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

Returns
Type	Description
ByteString	The bytes for parent.

hasInstanceDeadline()

public abstract boolean hasInstanceDeadline()

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

.google.protobuf.Timestamp instance_deadline = 5;

Returns
Type	Description
boolean	Whether the instanceDeadline field is set.