public static final class ListPluginInstancesRequest.Builder extends GeneratedMessageV3.Builder<ListPluginInstancesRequest.Builder> implements ListPluginInstancesRequestOrBuilder
The ListPluginInstances method's request.
Protobuf type google.cloud.apihub.v1.ListPluginInstancesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListPluginInstancesRequest.BuilderImplements
ListPluginInstancesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListPluginInstancesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
build()
public ListPluginInstancesRequest build()
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest |
buildPartial()
public ListPluginInstancesRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest |
clear()
public ListPluginInstancesRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListPluginInstancesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
clearFilter()
public ListPluginInstancesRequest.Builder clearFilter()
Optional. An expression that filters the list of plugin instances.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string. The
comparison operator must be one of: <
, >
or
=
. Filters are not case sensitive.
The following fields in the PluginInstances
are eligible for filtering:
state
- The state of the Plugin Instance. Allowed comparison operators:=
.A filter function is also supported in the filter string. The filter function is
id(name)
. Theid(name)
function returns the id of the resource name. For example,id(name) = \"plugin-instance-1\"
is equivalent toname = \"projects/test-project-id/locations/test-location-id/plugins/plugin-1/instances/plugin-instance-1\"
provided the parent isprojects/test-project-id/locations/test-location-id/plugins/plugin-1
.Expressions are combined with either
AND
logic operator orOR
logical operator but not both of them together i.e. only one of theAND
orOR
operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that thenINVALID_ARGUMENT
error is returned by the API. Here are a few examples:state = ENABLED
- The plugin instance is in enabled state.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListPluginInstancesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
clearPageSize()
public ListPluginInstancesRequest.Builder clearPageSize()
Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListPluginInstancesRequest.Builder clearPageToken()
Optional. A page token, received from a previous ListPluginInstances
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPluginInstances
must match the call that provided the page token.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
This builder for chaining. |
clearParent()
public ListPluginInstancesRequest.Builder clearParent()
Required. The parent resource where this plugin will be created.
Format: projects/{project}/locations/{location}/plugins/{plugin}
.
To list plugin instances for multiple plugins,
use the - character instead of the plugin ID.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
This builder for chaining. |
clone()
public ListPluginInstancesRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
getDefaultInstanceForType()
public ListPluginInstancesRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getFilter()
public String getFilter()
Optional. An expression that filters the list of plugin instances.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string. The
comparison operator must be one of: <
, >
or
=
. Filters are not case sensitive.
The following fields in the PluginInstances
are eligible for filtering:
state
- The state of the Plugin Instance. Allowed comparison operators:=
.A filter function is also supported in the filter string. The filter function is
id(name)
. Theid(name)
function returns the id of the resource name. For example,id(name) = \"plugin-instance-1\"
is equivalent toname = \"projects/test-project-id/locations/test-location-id/plugins/plugin-1/instances/plugin-instance-1\"
provided the parent isprojects/test-project-id/locations/test-location-id/plugins/plugin-1
.Expressions are combined with either
AND
logic operator orOR
logical operator but not both of them together i.e. only one of theAND
orOR
operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that thenINVALID_ARGUMENT
error is returned by the API. Here are a few examples:state = ENABLED
- The plugin instance is in enabled state.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes()
Optional. An expression that filters the list of plugin instances.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string. The
comparison operator must be one of: <
, >
or
=
. Filters are not case sensitive.
The following fields in the PluginInstances
are eligible for filtering:
state
- The state of the Plugin Instance. Allowed comparison operators:=
.A filter function is also supported in the filter string. The filter function is
id(name)
. Theid(name)
function returns the id of the resource name. For example,id(name) = \"plugin-instance-1\"
is equivalent toname = \"projects/test-project-id/locations/test-location-id/plugins/plugin-1/instances/plugin-instance-1\"
provided the parent isprojects/test-project-id/locations/test-location-id/plugins/plugin-1
.Expressions are combined with either
AND
logic operator orOR
logical operator but not both of them together i.e. only one of theAND
orOR
operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that thenINVALID_ARGUMENT
error is returned by the API. Here are a few examples:state = ENABLED
- The plugin instance is in enabled state.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for filter. |
getPageSize()
public int getPageSize()
Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The pageSize. |
getPageToken()
public String getPageToken()
Optional. A page token, received from a previous ListPluginInstances
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPluginInstances
must match the call that provided the page token.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()
Optional. A page token, received from a previous ListPluginInstances
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPluginInstances
must match the call that provided the page token.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for pageToken. |
getParent()
public String getParent()
Required. The parent resource where this plugin will be created.
Format: projects/{project}/locations/{location}/plugins/{plugin}
.
To list plugin instances for multiple plugins,
use the - character instead of the plugin ID.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes()
Required. The parent resource where this plugin will be created.
Format: projects/{project}/locations/{location}/plugins/{plugin}
.
To list plugin instances for multiple plugins,
use the - character instead of the plugin ID.
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 |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(ListPluginInstancesRequest other)
public ListPluginInstancesRequest.Builder mergeFrom(ListPluginInstancesRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListPluginInstancesRequest |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListPluginInstancesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListPluginInstancesRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListPluginInstancesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListPluginInstancesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
setFilter(String value)
public ListPluginInstancesRequest.Builder setFilter(String value)
Optional. An expression that filters the list of plugin instances.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string. The
comparison operator must be one of: <
, >
or
=
. Filters are not case sensitive.
The following fields in the PluginInstances
are eligible for filtering:
state
- The state of the Plugin Instance. Allowed comparison operators:=
.A filter function is also supported in the filter string. The filter function is
id(name)
. Theid(name)
function returns the id of the resource name. For example,id(name) = \"plugin-instance-1\"
is equivalent toname = \"projects/test-project-id/locations/test-location-id/plugins/plugin-1/instances/plugin-instance-1\"
provided the parent isprojects/test-project-id/locations/test-location-id/plugins/plugin-1
.Expressions are combined with either
AND
logic operator orOR
logical operator but not both of them together i.e. only one of theAND
orOR
operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that thenINVALID_ARGUMENT
error is returned by the API. Here are a few examples:state = ENABLED
- The plugin instance is in enabled state.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The filter to set. |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListPluginInstancesRequest.Builder setFilterBytes(ByteString value)
Optional. An expression that filters the list of plugin instances.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string. The
comparison operator must be one of: <
, >
or
=
. Filters are not case sensitive.
The following fields in the PluginInstances
are eligible for filtering:
state
- The state of the Plugin Instance. Allowed comparison operators:=
.A filter function is also supported in the filter string. The filter function is
id(name)
. Theid(name)
function returns the id of the resource name. For example,id(name) = \"plugin-instance-1\"
is equivalent toname = \"projects/test-project-id/locations/test-location-id/plugins/plugin-1/instances/plugin-instance-1\"
provided the parent isprojects/test-project-id/locations/test-location-id/plugins/plugin-1
.Expressions are combined with either
AND
logic operator orOR
logical operator but not both of them together i.e. only one of theAND
orOR
operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that thenINVALID_ARGUMENT
error is returned by the API. Here are a few examples:state = ENABLED
- The plugin instance is in enabled state.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListPluginInstancesRequest.Builder setPageSize(int value)
Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
int The pageSize to set. |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListPluginInstancesRequest.Builder setPageToken(String value)
Optional. A page token, received from a previous ListPluginInstances
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPluginInstances
must match the call that provided the page token.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The pageToken to set. |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListPluginInstancesRequest.Builder setPageTokenBytes(ByteString value)
Optional. A page token, received from a previous ListPluginInstances
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListPluginInstances
must match the call that provided the page token.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListPluginInstancesRequest.Builder setParent(String value)
Required. The parent resource where this plugin will be created.
Format: projects/{project}/locations/{location}/plugins/{plugin}
.
To list plugin instances for multiple plugins,
use the - character instead of the plugin ID.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The parent to set. |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListPluginInstancesRequest.Builder setParentBytes(ByteString value)
Required. The parent resource where this plugin will be created.
Format: projects/{project}/locations/{location}/plugins/{plugin}
.
To list plugin instances for multiple plugins,
use the - character instead of the plugin ID.
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 |
ListPluginInstancesRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListPluginInstancesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListPluginInstancesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListPluginInstancesRequest.Builder |