public static final class ListVersionsRequest.Builder extends GeneratedMessageV3.Builder<ListVersionsRequest.Builder> implements ListVersionsRequestOrBuilder
The ListVersions method's request.
Protobuf type google.cloud.apihub.v1.ListVersionsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListVersionsRequest.BuilderImplements
ListVersionsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListVersionsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
build()
public ListVersionsRequest build()
Returns | |
---|---|
Type | Description |
ListVersionsRequest |
buildPartial()
public ListVersionsRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListVersionsRequest |
clear()
public ListVersionsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListVersionsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
clearFilter()
public ListVersionsRequest.Builder clearFilter()
Optional. An expression that filters the list of Versions.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string, a
number, or a boolean. The comparison operator must be one of: <
, >
or
=
. Filters are not case sensitive.
The following fields in the Version
are eligible for filtering:
display_name
- The display name of the Version. Allowed comparison operators:=
.create_time
- The time at which the Version was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators:>
and<
.lifecycle.enum_values.values.id
- The allowed value id of the lifecycle attribute associated with the Version. Allowed comparison operators::
.lifecycle.enum_values.values.display_name
- The allowed value display name of the lifecycle attribute associated with the Version. Allowed comparison operators::
.compliance.enum_values.values.id
- The allowed value id of the compliances attribute associated with the Version. Allowed comparison operators::
.compliance.enum_values.values.display_name
- The allowed value display name of the compliances attribute associated with the Version. Allowed comparison operators::
.accreditation.enum_values.values.id
- The allowed value id of the accreditations attribute associated with the Version. Allowed comparison operators::
.accreditation.enum_values.values.display_name
- The allowed value display name of the accreditations attribute associated with the Version. 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:
lifecycle.enum_values.values.id: preview-id
- The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is preview-id.lifecycle.enum_values.values.display_name: \"Preview Display Name\"
- The filter string specifies that the display name of the allowed value associated with the lifecycle attribute of the Version isPreview Display Name
.lifecycle.enum_values.values.id: preview-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"
- The id of the allowed value associated with the lifecycle attribute of the Version is preview-id and it was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.compliance.enum_values.values.id: gdpr-id OR compliance.enum_values.values.id: pci-dss-id
- The id of the allowed value associated with the compliance attribute is gdpr-id or pci-dss-id.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListVersionsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
clearPageSize()
public ListVersionsRequest.Builder clearPageSize()
Optional. The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions 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 |
ListVersionsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListVersionsRequest.Builder clearPageToken()
Optional. A page token, received from a previous ListVersions
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListVersions
must match the call that provided the page token.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
This builder for chaining. |
clearParent()
public ListVersionsRequest.Builder clearParent()
Required. The parent which owns this collection of API versions i.e., the
API resource Format: projects/{project}/locations/{location}/apis/{api}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
This builder for chaining. |
clone()
public ListVersionsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
getDefaultInstanceForType()
public ListVersionsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListVersionsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getFilter()
public String getFilter()
Optional. An expression that filters the list of Versions.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string, a
number, or a boolean. The comparison operator must be one of: <
, >
or
=
. Filters are not case sensitive.
The following fields in the Version
are eligible for filtering:
display_name
- The display name of the Version. Allowed comparison operators:=
.create_time
- The time at which the Version was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators:>
and<
.lifecycle.enum_values.values.id
- The allowed value id of the lifecycle attribute associated with the Version. Allowed comparison operators::
.lifecycle.enum_values.values.display_name
- The allowed value display name of the lifecycle attribute associated with the Version. Allowed comparison operators::
.compliance.enum_values.values.id
- The allowed value id of the compliances attribute associated with the Version. Allowed comparison operators::
.compliance.enum_values.values.display_name
- The allowed value display name of the compliances attribute associated with the Version. Allowed comparison operators::
.accreditation.enum_values.values.id
- The allowed value id of the accreditations attribute associated with the Version. Allowed comparison operators::
.accreditation.enum_values.values.display_name
- The allowed value display name of the accreditations attribute associated with the Version. 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:
lifecycle.enum_values.values.id: preview-id
- The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is preview-id.lifecycle.enum_values.values.display_name: \"Preview Display Name\"
- The filter string specifies that the display name of the allowed value associated with the lifecycle attribute of the Version isPreview Display Name
.lifecycle.enum_values.values.id: preview-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"
- The id of the allowed value associated with the lifecycle attribute of the Version is preview-id and it was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.compliance.enum_values.values.id: gdpr-id OR compliance.enum_values.values.id: pci-dss-id
- The id of the allowed value associated with the compliance attribute is gdpr-id or pci-dss-id.
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 Versions.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string, a
number, or a boolean. The comparison operator must be one of: <
, >
or
=
. Filters are not case sensitive.
The following fields in the Version
are eligible for filtering:
display_name
- The display name of the Version. Allowed comparison operators:=
.create_time
- The time at which the Version was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators:>
and<
.lifecycle.enum_values.values.id
- The allowed value id of the lifecycle attribute associated with the Version. Allowed comparison operators::
.lifecycle.enum_values.values.display_name
- The allowed value display name of the lifecycle attribute associated with the Version. Allowed comparison operators::
.compliance.enum_values.values.id
- The allowed value id of the compliances attribute associated with the Version. Allowed comparison operators::
.compliance.enum_values.values.display_name
- The allowed value display name of the compliances attribute associated with the Version. Allowed comparison operators::
.accreditation.enum_values.values.id
- The allowed value id of the accreditations attribute associated with the Version. Allowed comparison operators::
.accreditation.enum_values.values.display_name
- The allowed value display name of the accreditations attribute associated with the Version. 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:
lifecycle.enum_values.values.id: preview-id
- The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is preview-id.lifecycle.enum_values.values.display_name: \"Preview Display Name\"
- The filter string specifies that the display name of the allowed value associated with the lifecycle attribute of the Version isPreview Display Name
.lifecycle.enum_values.values.id: preview-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"
- The id of the allowed value associated with the lifecycle attribute of the Version is preview-id and it was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.compliance.enum_values.values.id: gdpr-id OR compliance.enum_values.values.id: pci-dss-id
- The id of the allowed value associated with the compliance attribute is gdpr-id or pci-dss-id.
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 versions to return. The service may return fewer than this value. If unspecified, at most 50 versions 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 ListVersions
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListVersions
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 ListVersions
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListVersions
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 which owns this collection of API versions i.e., the
API resource Format: projects/{project}/locations/{location}/apis/{api}
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 which owns this collection of API versions i.e., the
API resource Format: projects/{project}/locations/{location}/apis/{api}
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(ListVersionsRequest other)
public ListVersionsRequest.Builder mergeFrom(ListVersionsRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListVersionsRequest |
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListVersionsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListVersionsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListVersionsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListVersionsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
setFilter(String value)
public ListVersionsRequest.Builder setFilter(String value)
Optional. An expression that filters the list of Versions.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string, a
number, or a boolean. The comparison operator must be one of: <
, >
or
=
. Filters are not case sensitive.
The following fields in the Version
are eligible for filtering:
display_name
- The display name of the Version. Allowed comparison operators:=
.create_time
- The time at which the Version was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators:>
and<
.lifecycle.enum_values.values.id
- The allowed value id of the lifecycle attribute associated with the Version. Allowed comparison operators::
.lifecycle.enum_values.values.display_name
- The allowed value display name of the lifecycle attribute associated with the Version. Allowed comparison operators::
.compliance.enum_values.values.id
- The allowed value id of the compliances attribute associated with the Version. Allowed comparison operators::
.compliance.enum_values.values.display_name
- The allowed value display name of the compliances attribute associated with the Version. Allowed comparison operators::
.accreditation.enum_values.values.id
- The allowed value id of the accreditations attribute associated with the Version. Allowed comparison operators::
.accreditation.enum_values.values.display_name
- The allowed value display name of the accreditations attribute associated with the Version. 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:
lifecycle.enum_values.values.id: preview-id
- The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is preview-id.lifecycle.enum_values.values.display_name: \"Preview Display Name\"
- The filter string specifies that the display name of the allowed value associated with the lifecycle attribute of the Version isPreview Display Name
.lifecycle.enum_values.values.id: preview-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"
- The id of the allowed value associated with the lifecycle attribute of the Version is preview-id and it was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.compliance.enum_values.values.id: gdpr-id OR compliance.enum_values.values.id: pci-dss-id
- The id of the allowed value associated with the compliance attribute is gdpr-id or pci-dss-id.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The filter to set. |
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListVersionsRequest.Builder setFilterBytes(ByteString value)
Optional. An expression that filters the list of Versions.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string, a
number, or a boolean. The comparison operator must be one of: <
, >
or
=
. Filters are not case sensitive.
The following fields in the Version
are eligible for filtering:
display_name
- The display name of the Version. Allowed comparison operators:=
.create_time
- The time at which the Version was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators:>
and<
.lifecycle.enum_values.values.id
- The allowed value id of the lifecycle attribute associated with the Version. Allowed comparison operators::
.lifecycle.enum_values.values.display_name
- The allowed value display name of the lifecycle attribute associated with the Version. Allowed comparison operators::
.compliance.enum_values.values.id
- The allowed value id of the compliances attribute associated with the Version. Allowed comparison operators::
.compliance.enum_values.values.display_name
- The allowed value display name of the compliances attribute associated with the Version. Allowed comparison operators::
.accreditation.enum_values.values.id
- The allowed value id of the accreditations attribute associated with the Version. Allowed comparison operators::
.accreditation.enum_values.values.display_name
- The allowed value display name of the accreditations attribute associated with the Version. 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:
lifecycle.enum_values.values.id: preview-id
- The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is preview-id.lifecycle.enum_values.values.display_name: \"Preview Display Name\"
- The filter string specifies that the display name of the allowed value associated with the lifecycle attribute of the Version isPreview Display Name
.lifecycle.enum_values.values.id: preview-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"
- The id of the allowed value associated with the lifecycle attribute of the Version is preview-id and it was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC.compliance.enum_values.values.id: gdpr-id OR compliance.enum_values.values.id: pci-dss-id
- The id of the allowed value associated with the compliance attribute is gdpr-id or pci-dss-id.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListVersionsRequest.Builder setPageSize(int value)
Optional. The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions 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 |
ListVersionsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListVersionsRequest.Builder setPageToken(String value)
Optional. A page token, received from a previous ListVersions
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListVersions
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 |
ListVersionsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListVersionsRequest.Builder setPageTokenBytes(ByteString value)
Optional. A page token, received from a previous ListVersions
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListVersions
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 |
ListVersionsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListVersionsRequest.Builder setParent(String value)
Required. The parent which owns this collection of API versions i.e., the
API resource Format: projects/{project}/locations/{location}/apis/{api}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The parent to set. |
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListVersionsRequest.Builder setParentBytes(ByteString value)
Required. The parent which owns this collection of API versions i.e., the
API resource Format: projects/{project}/locations/{location}/apis/{api}
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 |
ListVersionsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListVersionsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListVersionsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListVersionsRequest.Builder |