Interface ListDeploymentsRequestOrBuilder (0.52.0) 

public interface ListDeploymentsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

Lists the Deployments 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/foo/locations/us-central1/deployments/bar

  • 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

  • Filter by state:

    • Deployments in CREATING state. state=CREATING

string filter = 4;

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Lists the Deployments 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/foo/locations/us-central1/deployments/bar

  • 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

  • Filter by state:

    • Deployments in CREATING state. state=CREATING

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()

When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

Required. The parent in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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 in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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

Returns
Type Description
ByteString

The bytes for parent.