Class ListRepositoriesRequest.Builder (1.82.0)

public static final class ListRepositoriesRequest.Builder extends GeneratedMessage.Builder<ListRepositoriesRequest.Builder> implements ListRepositoriesRequestOrBuilder

The request to list repositories.

Protobuf type google.devtools.artifactregistry.v1.ListRepositoriesRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListRepositoriesRequest build()
Returns
Type Description
ListRepositoriesRequest

buildPartial()

public ListRepositoriesRequest buildPartial()
Returns
Type Description
ListRepositoriesRequest

clear()

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

clearFilter()

public ListRepositoriesRequest.Builder clearFilter()

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

  • name

    Examples of using a filter:

    To filter the results of your request to repositories with the name my-repo in project my-project in the us-central region, append the following filter expression to your request:

  • name="projects/my-project/locations/us-central1/repositories/my-repo"

    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-*"

  • name="projects/my-project/locations/us-central1/repositories/*repo"
  • name="projects/my-project/locations/us-central1/repositories/*repo*"

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListRepositoriesRequest.Builder

This builder for chaining.

clearOrderBy()

public ListRepositoriesRequest.Builder clearOrderBy()

Optional. The field to order the results by.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListRepositoriesRequest.Builder

This builder for chaining.

clearPageSize()

public ListRepositoriesRequest.Builder clearPageSize()

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

int32 page_size = 2;

Returns
Type Description
ListRepositoriesRequest.Builder

This builder for chaining.

clearPageToken()

public ListRepositoriesRequest.Builder clearPageToken()

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

string page_token = 3;

Returns
Type Description
ListRepositoriesRequest.Builder

This builder for chaining.

clearParent()

public ListRepositoriesRequest.Builder clearParent()

Required. The name of the parent resource whose repositories will be listed.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListRepositoriesRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListRepositoriesRequest getDefaultInstanceForType()
Returns
Type Description
ListRepositoriesRequest

getDescriptorForType()

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

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

    Examples of using a filter:

    To filter the results of your request to repositories with the name my-repo in project my-project in the us-central region, append the following filter expression to your request:

  • name="projects/my-project/locations/us-central1/repositories/my-repo"

    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-*"

  • name="projects/my-project/locations/us-central1/repositories/*repo"
  • name="projects/my-project/locations/us-central1/repositories/*repo*"

string filter = 4 [(.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

    Examples of using a filter:

    To filter the results of your request to repositories with the name my-repo in project my-project in the us-central region, append the following filter expression to your request:

  • name="projects/my-project/locations/us-central1/repositories/my-repo"

    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-*"

  • name="projects/my-project/locations/us-central1/repositories/*repo"
  • name="projects/my-project/locations/us-central1/repositories/*repo*"

string filter = 4 [(.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 repositories 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 parent resource whose repositories will be listed.

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 parent resource whose repositories will be listed.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListRepositoriesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFilter(String value)

public ListRepositoriesRequest.Builder setFilter(String value)

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

  • name

    Examples of using a filter:

    To filter the results of your request to repositories with the name my-repo in project my-project in the us-central region, append the following filter expression to your request:

  • name="projects/my-project/locations/us-central1/repositories/my-repo"

    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-*"

  • name="projects/my-project/locations/us-central1/repositories/*repo"
  • name="projects/my-project/locations/us-central1/repositories/*repo*"

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListRepositoriesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListRepositoriesRequest.Builder setFilterBytes(ByteString value)

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

  • name

    Examples of using a filter:

    To filter the results of your request to repositories with the name my-repo in project my-project in the us-central region, append the following filter expression to your request:

  • name="projects/my-project/locations/us-central1/repositories/my-repo"

    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-*"

  • name="projects/my-project/locations/us-central1/repositories/*repo"
  • name="projects/my-project/locations/us-central1/repositories/*repo*"

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListRepositoriesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListRepositoriesRequest.Builder setOrderBy(String value)

Optional. The field to order the results by.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListRepositoriesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListRepositoriesRequest.Builder setOrderByBytes(ByteString value)

Optional. The field to order the results by.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListRepositoriesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListRepositoriesRequest.Builder setPageSize(int value)

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

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListRepositoriesRequest.Builder

This builder for chaining.

setPageToken(String value)

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

This builder for chaining.

setPageTokenBytes(ByteString value)

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

This builder for chaining.

setParent(String value)

public ListRepositoriesRequest.Builder setParent(String value)

Required. The name of the parent resource whose repositories will be listed.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListRepositoriesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListRepositoriesRequest.Builder setParentBytes(ByteString value)

Required. The name of the parent resource whose repositories will be listed.

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

This builder for chaining.