public final class ListVersionsRequest extends GeneratedMessageV3 implements ListVersionsRequestOrBuilder
The ListVersions method's
request.
Protobuf type google.cloud.apihub.v1.ListVersionsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_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 |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListVersionsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListVersionsRequest.Builder newBuilder()
newBuilder(ListVersionsRequest prototype)
public static ListVersionsRequest.Builder newBuilder(ListVersionsRequest prototype)
public static ListVersionsRequest parseDelimitedFrom(InputStream input)
public static ListVersionsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListVersionsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListVersionsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListVersionsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListVersionsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListVersionsRequest parseFrom(CodedInputStream input)
public static ListVersionsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListVersionsRequest parseFrom(InputStream input)
public static ListVersionsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListVersionsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListVersionsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListVersionsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListVersionsRequest getDefaultInstanceForType()
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 or OR logical
operator but not both of them together i.e. only one of the AND or OR
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 then INVALID_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 is Preview
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 or OR logical
operator but not both of them together i.e. only one of the AND or OR
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 then INVALID_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 is Preview
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()
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.
|
getParserForType()
public Parser<ListVersionsRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListVersionsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListVersionsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ListVersionsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
