Class SearchProtectedResourcesRequest (0.40.0)

public final class SearchProtectedResourcesRequest extends GeneratedMessageV3 implements SearchProtectedResourcesRequestOrBuilder

Request message for KeyTrackingService.SearchProtectedResources.

Protobuf type google.cloud.kms.inventory.v1.SearchProtectedResourcesRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchProtectedResourcesRequest

Static Fields

CRYPTO_KEY_FIELD_NUMBER

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

RESOURCE_TYPES_FIELD_NUMBER

public static final int RESOURCE_TYPES_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchProtectedResourcesRequest getDefaultInstance()
Returns
Type Description
SearchProtectedResourcesRequest

getDescriptor()

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

newBuilder()

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

newBuilder(SearchProtectedResourcesRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCryptoKey()

public String getCryptoKey()

Required. The resource name of the CryptoKey.

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

Returns
Type Description
String

The cryptoKey.

getCryptoKeyBytes()

public ByteString getCryptoKeyBytes()

Required. The resource name of the CryptoKey.

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

Returns
Type Description
ByteString

The bytes for cryptoKey.

getDefaultInstanceForType()

public SearchProtectedResourcesRequest getDefaultInstanceForType()
Returns
Type Description
SearchProtectedResourcesRequest

getPageSize()

public int getPageSize()

The maximum number of resources to return. The service may return fewer than this value. If unspecified, at most 500 resources will be returned. The maximum value is 500; values above 500 will be coerced to 500.

int32 page_size = 3;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A page token, received from a previous KeyTrackingService.SearchProtectedResources call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to KeyTrackingService.SearchProtectedResources must match the call that provided the page token.

string page_token = 4;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token, received from a previous KeyTrackingService.SearchProtectedResources call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to KeyTrackingService.SearchProtectedResources must match the call that provided the page token.

string page_token = 4;

Returns
Type Description
ByteString

The bytes for pageToken.

getParserForType()

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

getResourceTypes(int index)

public String getResourceTypes(int index)

Optional. A list of resource types that this request searches for. If empty, it will search all the trackable resource types.

Regular expressions are also supported. For example:

  • compute.googleapis.com.* snapshots resources whose type starts with compute.googleapis.com.
  • .*Image snapshots resources whose type ends with Image.
  • .Image. snapshots resources whose type contains Image.

    See RE2 for all supported regular expression syntax. If the regular expression does not match any supported resource type, an INVALID_ARGUMENT error will be returned.

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

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The resourceTypes at the given index.

getResourceTypesBytes(int index)

public ByteString getResourceTypesBytes(int index)

Optional. A list of resource types that this request searches for. If empty, it will search all the trackable resource types.

Regular expressions are also supported. For example:

  • compute.googleapis.com.* snapshots resources whose type starts with compute.googleapis.com.
  • .*Image snapshots resources whose type ends with Image.
  • .Image. snapshots resources whose type contains Image.

    See RE2 for all supported regular expression syntax. If the regular expression does not match any supported resource type, an INVALID_ARGUMENT error will be returned.

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

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the resourceTypes at the given index.

getResourceTypesCount()

public int getResourceTypesCount()

Optional. A list of resource types that this request searches for. If empty, it will search all the trackable resource types.

Regular expressions are also supported. For example:

  • compute.googleapis.com.* snapshots resources whose type starts with compute.googleapis.com.
  • .*Image snapshots resources whose type ends with Image.
  • .Image. snapshots resources whose type contains Image.

    See RE2 for all supported regular expression syntax. If the regular expression does not match any supported resource type, an INVALID_ARGUMENT error will be returned.

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

Returns
Type Description
int

The count of resourceTypes.

getResourceTypesList()

public ProtocolStringList getResourceTypesList()

Optional. A list of resource types that this request searches for. If empty, it will search all the trackable resource types.

Regular expressions are also supported. For example:

  • compute.googleapis.com.* snapshots resources whose type starts with compute.googleapis.com.
  • .*Image snapshots resources whose type ends with Image.
  • .Image. snapshots resources whose type contains Image.

    See RE2 for all supported regular expression syntax. If the regular expression does not match any supported resource type, an INVALID_ARGUMENT error will be returned.

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

Returns
Type Description
ProtocolStringList

A list containing the resourceTypes.

getScope()

public String getScope()

Required. Resource name of the organization. Example: organizations/123

string scope = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The scope.

getScopeBytes()

public ByteString getScopeBytes()

Required. Resource name of the organization. Example: organizations/123

string scope = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for scope.

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 SearchProtectedResourcesRequest.Builder newBuilderForType()
Returns
Type Description
SearchProtectedResourcesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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