Interface ListPackagesRequestOrBuilder (1.54.0) 

public interface ListPackagesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

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

  • name

  • annotations

    Examples of using a filter:

    To filter the results of your request to packages with the name my-package in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request:

  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package"

    You can also use wildcards to match any number of characters before or after the value:

  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*"

  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*package"

  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*pack*"

    To filter the results of your request to packages with the annotation key-value pair [external_link: external_link_value], append the following filter expression to your request":

  • "annotations.external_link:external_link_value"

    To filter the results just for a specific annotation key external_link, append the following filter expression to your request:

  • "annotations.external_link"

    If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to packages with the annotation key-value pair [external.link:https://example.com/my-package], append the following filter expression to your request:

  • "annotations.external.link:https://example.com/my-package"

    You can also filter with annotations with a wildcard to match any number of characters before or after the value:

  • "annotations._link:example.com*"

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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

  • name

  • annotations

    Examples of using a filter:

    To filter the results of your request to packages with the name my-package in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request:

  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package"

    You can also use wildcards to match any number of characters before or after the value:

  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*"

  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*package"

  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*pack*"

    To filter the results of your request to packages with the annotation key-value pair [external_link: external_link_value], append the following filter expression to your request":

  • "annotations.external_link:external_link_value"

    To filter the results just for a specific annotation key external_link, append the following filter expression to your request:

  • "annotations.external_link"

    If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to packages with the annotation key-value pair [external.link:https://example.com/my-package], append the following filter expression to your request:

  • "annotations.external.link:https://example.com/my-package"

    You can also filter with annotations with a wildcard to match any number of characters before or after the value:

  • "annotations._link:example.com*"

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public abstract String getOrderBy()

Optional. The field to order the results by.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

Optional. The field to order the results by.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

The maximum number of packages to return. Maximum page size is 1,000.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

The next_page_token value returned from a previous list request, if any.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

The next_page_token value returned from a previous list request, if any.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

Required. The name of the parent resource whose packages will be listed.

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 parent resource whose packages will be listed.

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

Returns
Type Description
ByteString

The bytes for parent.