Class ListSecretsRequest (2.44.0)

public final class ListSecretsRequest extends GeneratedMessageV3 implements ListSecretsRequestOrBuilder

Request message for SecretManagerService.ListSecrets.

Protobuf type google.cloud.secretmanager.v1.ListSecretsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_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

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListSecretsRequest getDefaultInstance()
Returns
Type Description
ListSecretsRequest

getDescriptor()

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

newBuilder()

public static ListSecretsRequest.Builder newBuilder()
Returns
Type Description
ListSecretsRequest.Builder

newBuilder(ListSecretsRequest prototype)

public static ListSecretsRequest.Builder newBuilder(ListSecretsRequest prototype)
Parameter
Name Description
prototype ListSecretsRequest
Returns
Type Description
ListSecretsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListSecretsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListSecretsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSecretsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSecretsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListSecretsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListSecretsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListSecretsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSecretsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListSecretsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListSecretsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListSecretsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSecretsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListSecretsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListSecretsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSecretsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSecretsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListSecretsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListSecretsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSecretsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSecretsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListSecretsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListSecretsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListSecretsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSecretsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListSecretsRequest> parser()
Returns
Type Description
Parser<ListSecretsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListSecretsRequest getDefaultInstanceForType()
Returns
Type Description
ListSecretsRequest

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.

getParserForType()

public Parser<ListSecretsRequest> getParserForType()
Returns
Type Description
Parser<ListSecretsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListSecretsRequest.Builder newBuilderForType()
Returns
Type Description
ListSecretsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListSecretsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListSecretsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListSecretsRequest.Builder toBuilder()
Returns
Type Description
ListSecretsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException