Class ListTagsRequest.Builder (1.53.0)

public static final class ListTagsRequest.Builder extends GeneratedMessageV3.Builder<ListTagsRequest.Builder> implements ListTagsRequestOrBuilder

The request to list tags.

Protobuf type google.devtools.artifactregistry.v1.ListTagsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListTagsRequest build()
Returns
Type Description
ListTagsRequest

buildPartial()

public ListTagsRequest buildPartial()
Returns
Type Description
ListTagsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListTagsRequest.Builder clearFilter()

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

  • name
  • version

    Examples of using a filter:

    To filter the results of your request to tags with the name my-tag in package my-package in repository my-repo in project "y-project in the us-central region, append the following filter expression to your request:

  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"

    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/tags/my*"

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

    To filter the results of your request to tags applied to the version 1.0 in package my-package, append the following filter expression to your request:

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

string filter = 4;

Returns
Type Description
ListTagsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListTagsRequest.Builder clearPageSize()

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

int32 page_size = 2;

Returns
Type Description
ListTagsRequest.Builder

This builder for chaining.

clearPageToken()

public ListTagsRequest.Builder clearPageToken()

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

string page_token = 3;

Returns
Type Description
ListTagsRequest.Builder

This builder for chaining.

clearParent()

public ListTagsRequest.Builder clearParent()

The name of the parent package whose tags will be listed. For example: projects/p1/locations/us-central1/repositories/repo1/packages/pkg1.

string parent = 1;

Returns
Type Description
ListTagsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListTagsRequest getDefaultInstanceForType()
Returns
Type Description
ListTagsRequest

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
  • version

    Examples of using a filter:

    To filter the results of your request to tags with the name my-tag in package my-package in repository my-repo in project "y-project in the us-central region, append the following filter expression to your request:

  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"

    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/tags/my*"

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

    To filter the results of your request to tags applied to the version 1.0 in package my-package, append the following filter expression to your request:

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

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
  • version

    Examples of using a filter:

    To filter the results of your request to tags with the name my-tag in package my-package in repository my-repo in project "y-project in the us-central region, append the following filter expression to your request:

  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"

    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/tags/my*"

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

    To filter the results of your request to tags applied to the version 1.0 in package my-package, append the following filter expression to your request:

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

string filter = 4;

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

The maximum number of tags 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 package whose tags will be listed. For example: projects/p1/locations/us-central1/repositories/repo1/packages/pkg1.

string parent = 1;

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

The name of the parent package whose tags will be listed. For example: projects/p1/locations/us-central1/repositories/repo1/packages/pkg1.

string parent = 1;

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(ListTagsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListTagsRequest.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
  • version

    Examples of using a filter:

    To filter the results of your request to tags with the name my-tag in package my-package in repository my-repo in project "y-project in the us-central region, append the following filter expression to your request:

  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"

    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/tags/my*"

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

    To filter the results of your request to tags applied to the version 1.0 in package my-package, append the following filter expression to your request:

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

string filter = 4;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListTagsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListTagsRequest.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
  • version

    Examples of using a filter:

    To filter the results of your request to tags with the name my-tag in package my-package in repository my-repo in project "y-project in the us-central region, append the following filter expression to your request:

  • name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"

    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/tags/my*"

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

    To filter the results of your request to tags applied to the version 1.0 in package my-package, append the following filter expression to your request:

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

string filter = 4;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListTagsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListTagsRequest.Builder setPageSize(int value)

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

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListTagsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListTagsRequest.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
ListTagsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListTagsRequest.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
ListTagsRequest.Builder

This builder for chaining.

setParent(String value)

public ListTagsRequest.Builder setParent(String value)

The name of the parent package whose tags will be listed. For example: projects/p1/locations/us-central1/repositories/repo1/packages/pkg1.

string parent = 1;

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListTagsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListTagsRequest.Builder setParentBytes(ByteString value)

The name of the parent package whose tags will be listed. For example: projects/p1/locations/us-central1/repositories/repo1/packages/pkg1.

string parent = 1;

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListTagsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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