public static final class ListPluginsRequest.Builder extends GeneratedMessageV3.Builder<ListPluginsRequest.Builder> implements ListPluginsRequestOrBuilder
The ListPlugins method's request.
Protobuf type google.cloud.apihub.v1.ListPluginsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListPluginsRequest.BuilderImplements
ListPluginsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListPluginsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
build()
public ListPluginsRequest build()
Returns | |
---|---|
Type | Description |
ListPluginsRequest |
buildPartial()
public ListPluginsRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListPluginsRequest |
clear()
public ListPluginsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListPluginsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
clearFilter()
public ListPluginsRequest.Builder clearFilter()
Optional. An expression that filters the list of plugins.
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 Plugins
are eligible for filtering:
plugin_category
- The category of the Plugin. Allowed comparison operators:=
.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:plugin_category = ON_RAMP
- The plugin is of category on ramp.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListPluginsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
clearPageSize()
public ListPluginsRequest.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 |
ListPluginsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListPluginsRequest.Builder clearPageToken()
Optional. A page token, received from a previous ListPlugins
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListPlugins
must match the call that provided the page token.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
This builder for chaining. |
clearParent()
public ListPluginsRequest.Builder clearParent()
Required. The parent resource where this plugin will be created.
Format: projects/{project}/locations/{location}
.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
This builder for chaining. |
clone()
public ListPluginsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
getDefaultInstanceForType()
public ListPluginsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListPluginsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getFilter()
public String getFilter()
Optional. An expression that filters the list of plugins.
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 Plugins
are eligible for filtering:
plugin_category
- The category of the Plugin. Allowed comparison operators:=
.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:plugin_category = ON_RAMP
- The plugin is of category on ramp.
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 plugins.
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 Plugins
are eligible for filtering:
plugin_category
- The category of the Plugin. Allowed comparison operators:=
.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:plugin_category = ON_RAMP
- The plugin is of category on ramp.
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 ListPlugins
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListPlugins
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 ListPlugins
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListPlugins
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}
.
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}
.
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(ListPluginsRequest other)
public ListPluginsRequest.Builder mergeFrom(ListPluginsRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListPluginsRequest |
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListPluginsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListPluginsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListPluginsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListPluginsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
setFilter(String value)
public ListPluginsRequest.Builder setFilter(String value)
Optional. An expression that filters the list of plugins.
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 Plugins
are eligible for filtering:
plugin_category
- The category of the Plugin. Allowed comparison operators:=
.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:plugin_category = ON_RAMP
- The plugin is of category on ramp.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The filter to set. |
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListPluginsRequest.Builder setFilterBytes(ByteString value)
Optional. An expression that filters the list of plugins.
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 Plugins
are eligible for filtering:
plugin_category
- The category of the Plugin. Allowed comparison operators:=
.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:plugin_category = ON_RAMP
- The plugin is of category on ramp.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListPluginsRequest.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 |
ListPluginsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListPluginsRequest.Builder setPageToken(String value)
Optional. A page token, received from a previous ListPlugins
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListPlugins
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 |
ListPluginsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListPluginsRequest.Builder setPageTokenBytes(ByteString value)
Optional. A page token, received from a previous ListPlugins
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListPlugins
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 |
ListPluginsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListPluginsRequest.Builder setParent(String value)
Required. The parent resource where this plugin will be created.
Format: projects/{project}/locations/{location}
.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The parent to set. |
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListPluginsRequest.Builder setParentBytes(ByteString value)
Required. The parent resource where this plugin will be created.
Format: projects/{project}/locations/{location}
.
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 |
ListPluginsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListPluginsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListPluginsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListPluginsRequest.Builder |