public final class ListVersionsRequest extends GeneratedMessageV3 implements ListVersionsRequestOrBuilder
The request to list versions.
Protobuf type google.devtools.artifactregistry.v1.ListVersionsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int FILTER_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
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 |
|
public static final int PARENT_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int VIEW_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
public static ListVersionsRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ListVersionsRequest.Builder newBuilder()
public static ListVersionsRequest.Builder newBuilder(ListVersionsRequest prototype)
public static ListVersionsRequest parseDelimitedFrom(InputStream input)
public static ListVersionsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListVersionsRequest parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
public static ListVersionsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListVersionsRequest parseFrom(ByteString data)
public static ListVersionsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListVersionsRequest parseFrom(CodedInputStream input)
public static ListVersionsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListVersionsRequest parseFrom(InputStream input)
public static ListVersionsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListVersionsRequest parseFrom(ByteBuffer data)
public static ListVersionsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ListVersionsRequest> parser()
Methods
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
public ListVersionsRequest getDefaultInstanceForType()
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.
|
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.
|
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.
|
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()
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.
|
public String getParent()
The name of the parent resource whose versions will be listed.
string parent = 1;
Returns |
Type |
Description |
String |
The parent.
|
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.
|
public Parser<ListVersionsRequest> getParserForType()
Overrides
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
public VersionView getView()
The view that should be returned in the response.
.google.devtools.artifactregistry.v1.VersionView view = 4;
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.
|
Returns |
Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ListVersionsRequest.Builder newBuilderForType()
protected ListVersionsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
public ListVersionsRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides