Interface ListConnectivityTestsRequestOrBuilder (1.56.0)

public interface ListConnectivityTestsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

Lists the ConnectivityTests that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form <field> <operator> <value> where operators: <, >, <=, >=, !=, =, : are supported (colon : represents a HAS operator which is roughly synonymous with equality). <field> can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:

  • Filter by name: name = "projects/proj-1/locations/global/connectivityTests/test-1

  • Filter by labels:

    • Resources that have a key called foo labels.foo:*
    • Resources that have a key called foo whose value is bar labels.foo = bar

string filter = 4;

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Lists the ConnectivityTests that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form <field> <operator> <value> where operators: <, >, <=, >=, !=, =, : are supported (colon : represents a HAS operator which is roughly synonymous with equality). <field> can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:

  • Filter by name: name = "projects/proj-1/locations/global/connectivityTests/test-1

  • Filter by labels:

    • Resources that have a key called foo labels.foo:*
    • Resources that have a key called foo whose value is bar labels.foo = bar

string filter = 4;

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public abstract String getOrderBy()

Field to use to sort the list.

string order_by = 5;

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

Field to use to sort the list.

string order_by = 5;

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

Number of ConnectivityTests to return.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

Page token from an earlier query, as returned in next_page_token.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Page token from an earlier query, as returned in next_page_token.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

Required. The parent resource of the Connectivity Tests: projects/{project_id}/locations/global

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 parent resource of the Connectivity Tests: projects/{project_id}/locations/global

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

Returns
Type Description
ByteString

The bytes for parent.