public static final class SearchProtectedResourcesRequest.Builder extends GeneratedMessageV3.Builder<SearchProtectedResourcesRequest.Builder> implements SearchProtectedResourcesRequestOrBuilder
Request message for KeyTrackingService.SearchProtectedResources.
Protobuf type google.cloud.kms.inventory.v1.SearchProtectedResourcesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchProtectedResourcesRequest.BuilderImplements
SearchProtectedResourcesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllResourceTypes(Iterable<String> values)
public SearchProtectedResourcesRequest.Builder addAllResourceTypes(Iterable<String> values)
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 withcompute.googleapis.com
..*Image
snapshots resources whose type ends withImage
..Image.
snapshots resources whose type containsImage
.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 |
values |
Iterable<String> The resourceTypes to add. |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchProtectedResourcesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
addResourceTypes(String value)
public SearchProtectedResourcesRequest.Builder addResourceTypes(String value)
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 withcompute.googleapis.com
..*Image
snapshots resources whose type ends withImage
..Image.
snapshots resources whose type containsImage
.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 |
value |
String The resourceTypes to add. |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
addResourceTypesBytes(ByteString value)
public SearchProtectedResourcesRequest.Builder addResourceTypesBytes(ByteString value)
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 withcompute.googleapis.com
..*Image
snapshots resources whose type ends withImage
..Image.
snapshots resources whose type containsImage
.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 |
value |
ByteString The bytes of the resourceTypes to add. |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
build()
public SearchProtectedResourcesRequest build()
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest |
buildPartial()
public SearchProtectedResourcesRequest buildPartial()
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest |
clear()
public SearchProtectedResourcesRequest.Builder clear()
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
clearCryptoKey()
public SearchProtectedResourcesRequest.Builder clearCryptoKey()
Required. The resource name of the CryptoKey.
string crypto_key = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public SearchProtectedResourcesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchProtectedResourcesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
clearPageSize()
public SearchProtectedResourcesRequest.Builder clearPageSize()
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 |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
clearPageToken()
public SearchProtectedResourcesRequest.Builder clearPageToken()
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 |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
clearResourceTypes()
public SearchProtectedResourcesRequest.Builder clearResourceTypes()
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 withcompute.googleapis.com
..*Image
snapshots resources whose type ends withImage
..Image.
snapshots resources whose type containsImage
.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 |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
clearScope()
public SearchProtectedResourcesRequest.Builder clearScope()
Required. Resource name of the organization. Example: organizations/123
string scope = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
clone()
public SearchProtectedResourcesRequest.Builder clone()
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
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 |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
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 withcompute.googleapis.com
..*Image
snapshots resources whose type ends withImage
..Image.
snapshots resources whose type containsImage
.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 withcompute.googleapis.com
..*Image
snapshots resources whose type ends withImage
..Image.
snapshots resources whose type containsImage
.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 withcompute.googleapis.com
..*Image
snapshots resources whose type ends withImage
..Image.
snapshots resources whose type containsImage
.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 withcompute.googleapis.com
..*Image
snapshots resources whose type ends withImage
..Image.
snapshots resources whose type containsImage
.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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(SearchProtectedResourcesRequest other)
public SearchProtectedResourcesRequest.Builder mergeFrom(SearchProtectedResourcesRequest other)
Parameter | |
---|---|
Name | Description |
other |
SearchProtectedResourcesRequest |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchProtectedResourcesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public SearchProtectedResourcesRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchProtectedResourcesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
setCryptoKey(String value)
public SearchProtectedResourcesRequest.Builder setCryptoKey(String value)
Required. The resource name of the CryptoKey.
string crypto_key = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The cryptoKey to set. |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
setCryptoKeyBytes(ByteString value)
public SearchProtectedResourcesRequest.Builder setCryptoKeyBytes(ByteString value)
Required. The resource name of the CryptoKey.
string crypto_key = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for cryptoKey to set. |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchProtectedResourcesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
setPageSize(int value)
public SearchProtectedResourcesRequest.Builder setPageSize(int value)
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;
Parameter | |
---|---|
Name | Description |
value |
int The pageSize to set. |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public SearchProtectedResourcesRequest.Builder setPageToken(String value)
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;
Parameter | |
---|---|
Name | Description |
value |
String The pageToken to set. |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public SearchProtectedResourcesRequest.Builder setPageTokenBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchProtectedResourcesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
setResourceTypes(int index, String value)
public SearchProtectedResourcesRequest.Builder setResourceTypes(int index, String value)
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 withcompute.googleapis.com
..*Image
snapshots resources whose type ends withImage
..Image.
snapshots resources whose type containsImage
.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];
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
String The resourceTypes to set. |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
setScope(String value)
public SearchProtectedResourcesRequest.Builder setScope(String value)
Required. Resource name of the organization. Example: organizations/123
string scope = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The scope to set. |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
setScopeBytes(ByteString value)
public SearchProtectedResourcesRequest.Builder setScopeBytes(ByteString value)
Required. Resource name of the organization. Example: organizations/123
string scope = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for scope to set. |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchProtectedResourcesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
SearchProtectedResourcesRequest.Builder |