Class ListVersionsRequest (1.54.0)

public final class ListVersionsRequest extends GeneratedMessageV3 implements ListVersionsRequestOrBuilder

The request to list versions.

Protobuf type google.devtools.artifactregistry.v1.ListVersionsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

VIEW_FIELD_NUMBER

public static final int VIEW_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListVersionsRequest getDefaultInstance()
Returns
Type Description
ListVersionsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListVersionsRequest.Builder newBuilder()
Returns
Type Description
ListVersionsRequest.Builder

newBuilder(ListVersionsRequest prototype)

public static ListVersionsRequest.Builder newBuilder(ListVersionsRequest prototype)
Parameter
Name Description
prototype ListVersionsRequest
Returns
Type Description
ListVersionsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListVersionsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListVersionsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListVersionsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListVersionsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListVersionsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListVersionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListVersionsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListVersionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListVersionsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListVersionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListVersionsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListVersionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListVersionsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListVersionsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListVersionsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListVersionsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListVersionsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListVersionsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListVersionsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListVersionsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListVersionsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListVersionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListVersionsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListVersionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListVersionsRequest> parser()
Returns
Type Description
Parser<ListVersionsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListVersionsRequest getDefaultInstanceForType()
Returns
Type Description
ListVersionsRequest

getFilter()

public 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 versions with the name my-version 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/versions/my-version"

    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-package/versions/*version"

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

    To filter the results of your request to versions 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 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 versions with the annotation key-value pair [external.link:https://example.com/my-version], append the following filter expression to your request:

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

    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 = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public 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 versions with the name my-version 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/versions/my-version"

    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-package/versions/*version"

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

    To filter the results of your request to versions 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 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 versions with the annotation key-value pair [external.link:https://example.com/my-version], append the following filter expression to your request:

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

    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 = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public 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 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 int getPageSize()

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

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public 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 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 String getParent()

The name of the parent resource whose versions will be listed.

string parent = 1;

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

The name of the parent resource whose versions will be listed.

string parent = 1;

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListVersionsRequest> getParserForType()
Returns
Type Description
Parser<ListVersionsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getView()

public VersionView getView()

The view that should be returned in the response.

.google.devtools.artifactregistry.v1.VersionView view = 4;

Returns
Type Description
VersionView

The view.

getViewValue()

public int getViewValue()

The view that should be returned in the response.

.google.devtools.artifactregistry.v1.VersionView view = 4;

Returns
Type Description
int

The enum numeric value on the wire for view.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListVersionsRequest.Builder newBuilderForType()
Returns
Type Description
ListVersionsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListVersionsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListVersionsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListVersionsRequest.Builder toBuilder()
Returns
Type Description
ListVersionsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException