Class ListSecretsRequest.Builder (2.42.0)

public static final class ListSecretsRequest.Builder extends GeneratedMessageV3.Builder<ListSecretsRequest.Builder> implements ListSecretsRequestOrBuilder

Request message for SecretManagerService.ListSecrets.

Protobuf type google.cloud.secretmanager.v1.ListSecretsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListSecretsRequest build()
Returns
Type Description
ListSecretsRequest

buildPartial()

public ListSecretsRequest buildPartial()
Returns
Type Description
ListSecretsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListSecretsRequest.Builder clearFilter()

Optional. Filter string, adhering to the rules in List-operation filtering. List only secrets matching the filter. If filter is empty, all secrets are listed.

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

Returns
Type Description
ListSecretsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListSecretsRequest.Builder clearPageSize()

Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListSecretsRequest.Builder

This builder for chaining.

clearPageToken()

public ListSecretsRequest.Builder clearPageToken()

Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListSecretsRequest.Builder

This builder for chaining.

clearParent()

public ListSecretsRequest.Builder clearParent()

Required. The resource name of the project associated with the Secrets, in the format projects/* or projects/*/locations/*

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

Returns
Type Description
ListSecretsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListSecretsRequest getDefaultInstanceForType()
Returns
Type Description
ListSecretsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Filter string, adhering to the rules in List-operation filtering. List only secrets matching the filter. If filter is empty, all secrets are listed.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filter string, adhering to the rules in List-operation filtering. List only secrets matching the filter. If filter is empty, all secrets are listed.

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

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the project associated with the Secrets, in the format projects/* or projects/*/locations/*

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the project associated with the Secrets, in the format projects/* or projects/*/locations/*

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

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListSecretsRequest.Builder setFilter(String value)

Optional. Filter string, adhering to the rules in List-operation filtering. List only secrets matching the filter. If filter is empty, all secrets are listed.

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListSecretsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListSecretsRequest.Builder setFilterBytes(ByteString value)

Optional. Filter string, adhering to the rules in List-operation filtering. List only secrets matching the filter. If filter is empty, all secrets are listed.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListSecretsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListSecretsRequest.Builder setPageSize(int value)

Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListSecretsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListSecretsRequest.Builder setPageToken(String value)

Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListSecretsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListSecretsRequest.Builder setPageTokenBytes(ByteString value)

Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListSecretsRequest.Builder

This builder for chaining.

setParent(String value)

public ListSecretsRequest.Builder setParent(String value)

Required. The resource name of the project associated with the Secrets, in the format projects/* or projects/*/locations/*

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListSecretsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListSecretsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the project associated with the Secrets, in the format projects/* or projects/*/locations/*

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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