public final class ListFilesRequest extends GeneratedMessageV3 implements ListFilesRequestOrBuilder
The request to list files.
Protobuf type google.devtools.artifactregistry.v1.ListFilesRequest
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 |
|
Static Methods
public static ListFilesRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ListFilesRequest.Builder newBuilder()
public static ListFilesRequest.Builder newBuilder(ListFilesRequest prototype)
public static ListFilesRequest parseDelimitedFrom(InputStream input)
public static ListFilesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListFilesRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static ListFilesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListFilesRequest parseFrom(ByteString data)
public static ListFilesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListFilesRequest parseFrom(CodedInputStream input)
public static ListFilesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListFilesRequest parseFrom(InputStream input)
public static ListFilesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListFilesRequest parseFrom(ByteBuffer data)
public static ListFilesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ListFilesRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public ListFilesRequest getDefaultInstanceForType()
public String getFilter()
An expression for filtering the results of the request. Filter rules are
case insensitive. The fields eligible for filtering are:
nameownerannotations
Examples of using a filter:
To filter the results of your request to files with the name my_file.txt
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/files/my-file.txt"
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/files/my-*"
name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt"name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file*"
To filter the results of your request to files owned by the version 1.0
in package pkg1, append the following filter expression to your request:
owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"
To filter the results of your request to files 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 files with the annotation key-value pair
[external.link:https://example.com/my-file], append the following
filter expression to your request:
"annotations.external.link:https://example.com/my-file"
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;
| Returns |
| Type |
Description |
String |
The filter.
|
public ByteString getFilterBytes()
An expression for filtering the results of the request. Filter rules are
case insensitive. The fields eligible for filtering are:
nameownerannotations
Examples of using a filter:
To filter the results of your request to files with the name my_file.txt
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/files/my-file.txt"
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/files/my-*"
name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt"name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file*"
To filter the results of your request to files owned by the version 1.0
in package pkg1, append the following filter expression to your request:
owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"
To filter the results of your request to files 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 files with the annotation key-value pair
[external.link:https://example.com/my-file], append the following
filter expression to your request:
"annotations.external.link:https://example.com/my-file"
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;
| Returns |
| Type |
Description |
ByteString |
The bytes for filter.
|
public String getOrderBy()
The field to order the results by.
string order_by = 5;
| Returns |
| Type |
Description |
String |
The orderBy.
|
public ByteString getOrderByBytes()
The field to order the results by.
string order_by = 5;
| Returns |
| Type |
Description |
ByteString |
The bytes for orderBy.
|
getPageSize()
The maximum number of files 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()
Required. The name of the repository whose files will be listed. For
example: "projects/p1/locations/us-central1/repositories/repo1
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The parent.
|
public ByteString getParentBytes()
Required. The name of the repository whose files will be listed. For
example: "projects/p1/locations/us-central1/repositories/repo1
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
public Parser<ListFilesRequest> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ListFilesRequest.Builder newBuilderForType()
protected ListFilesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public ListFilesRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
