Artifact Registry V1 API - Class Google::Cloud::ArtifactRegistry::V1::ListPackagesRequest (v1.2.0)

Reference documentation and code samples for the Artifact Registry V1 API class Google::Cloud::ArtifactRegistry::V1::ListPackagesRequest.

The request to list packages.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) —

    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*`"

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) —

    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*`"
Returns
  • (::String) —

    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*`"

#order_by

def order_by() -> ::String
Returns
  • (::String) — Optional. The field to order the results by.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — Optional. The field to order the results by.
Returns
  • (::String) — Optional. The field to order the results by.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — The maximum number of packages to return. Maximum page size is 1,000.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — The maximum number of packages to return. Maximum page size is 1,000.
Returns
  • (::Integer) — The maximum number of packages to return. Maximum page size is 1,000.

#page_token

def page_token() -> ::String
Returns
  • (::String) — The next_page_token value returned from a previous list request, if any.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — The next_page_token value returned from a previous list request, if any.
Returns
  • (::String) — The next_page_token value returned from a previous list request, if any.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The name of the parent resource whose packages will be listed.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the parent resource whose packages will be listed.
Returns
  • (::String) — Required. The name of the parent resource whose packages will be listed.