Class ListFilesRequest.Builder (1.54.0) 

public static final class ListFilesRequest.Builder extends GeneratedMessageV3.Builder<ListFilesRequest.Builder> implements ListFilesRequestOrBuilder

The request to list files.

Protobuf type google.devtools.artifactregistry.v1.ListFilesRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListFilesRequest.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListFilesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListFilesRequest.Builder
Overrides

build()

public ListFilesRequest build()
Returns
Type Description
ListFilesRequest

buildPartial()

public ListFilesRequest buildPartial()
Returns
Type Description
ListFilesRequest

clear()

public ListFilesRequest.Builder clear()
Returns
Type Description
ListFilesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListFilesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListFilesRequest.Builder
Overrides

clearFilter()

public ListFilesRequest.Builder clearFilter()

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

  • name
  • owner

  • annotations

    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
ListFilesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListFilesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListFilesRequest.Builder
Overrides

clearOrderBy()

public ListFilesRequest.Builder clearOrderBy()

The field to order the results by.

string order_by = 5;

Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

clearPageSize()

public ListFilesRequest.Builder clearPageSize()

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

int32 page_size = 2;

Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

clearPageToken()

public ListFilesRequest.Builder clearPageToken()

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

string page_token = 3;

Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

clearParent()

public ListFilesRequest.Builder clearParent()

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
ListFilesRequest.Builder

This builder for chaining.

clone()

public ListFilesRequest.Builder clone()
Returns
Type Description
ListFilesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListFilesRequest getDefaultInstanceForType()
Returns
Type Description
ListFilesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public String getFilter()

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

  • name
  • owner

  • annotations

    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.

getFilterBytes()

public ByteString getFilterBytes()

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

  • name
  • owner

  • annotations

    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.

getOrderBy()

public String getOrderBy()

The field to order the results by.

string order_by = 5;

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

The field to order the results by.

string order_by = 5;

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int 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.

getParent()

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.

getParentBytes()

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListFilesRequest other)

public ListFilesRequest.Builder mergeFrom(ListFilesRequest other)
Parameter
Name Description
other ListFilesRequest
Returns
Type Description
ListFilesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListFilesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListFilesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListFilesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListFilesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListFilesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListFilesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListFilesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListFilesRequest.Builder
Overrides

setFilter(String value)

public ListFilesRequest.Builder setFilter(String value)

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

  • name
  • owner

  • annotations

    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;

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListFilesRequest.Builder setFilterBytes(ByteString value)

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

  • name
  • owner

  • annotations

    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;

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListFilesRequest.Builder setOrderBy(String value)

The field to order the results by.

string order_by = 5;

Parameter
Name Description
value String

The orderBy to set.
Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListFilesRequest.Builder setOrderByBytes(ByteString value)

The field to order the results by.

string order_by = 5;

Parameter
Name Description
value ByteString

The bytes for orderBy to set.
Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListFilesRequest.Builder setPageSize(int value)

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

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListFilesRequest.Builder setPageToken(String value)

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

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListFilesRequest.Builder setPageTokenBytes(ByteString value)

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

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

setParent(String value)

public ListFilesRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListFilesRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
ListFilesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListFilesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListFilesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListFilesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListFilesRequest.Builder
Overrides