public final class ListSpecsRequest extends GeneratedMessageV3 implements ListSpecsRequestOrBuilder
The ListSpecs method's request.
Protobuf type google.cloud.apihub.v1.ListSpecsRequest
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 ListSpecsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListSpecsRequest.Builder newBuilder()
newBuilder(ListSpecsRequest prototype)
public static ListSpecsRequest.Builder newBuilder(ListSpecsRequest prototype)
public static ListSpecsRequest parseDelimitedFrom(InputStream input)
public static ListSpecsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListSpecsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListSpecsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListSpecsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListSpecsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListSpecsRequest parseFrom(CodedInputStream input)
public static ListSpecsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListSpecsRequest parseFrom(InputStream input)
public static ListSpecsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListSpecsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListSpecsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListSpecsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListSpecsRequest getDefaultInstanceForType()
getFilter()
public String getFilter()
Optional. An expression that filters the list of Specs.
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 Spec are eligible for filtering:
display_name - The display name of the Spec. Allowed comparison
operators: =.create_time - The time at which the Spec was created. The
value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
format. Allowed comparison operators: > and <.spec_type.enum_values.values.id - The allowed value id of the
spec_type attribute associated with the Spec. Allowed comparison
operators: :.spec_type.enum_values.values.display_name - The allowed value display
name of the spec_type attribute associated with the Spec. Allowed
comparison operators: :.lint_response.json_values.values - The json value of the
lint_response attribute associated with the Spec. Allowed comparison
operators: :.mime_type - The MIME type of the Spec. 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:
spec_type.enum_values.values.id: rest-id - The filter
string specifies that the id of the allowed value associated with the
spec_type attribute is rest-id.
spec_type.enum_values.values.display_name: \"Rest Display Name\" -
The filter string specifies that the display name of the allowed value
associated with the spec_type attribute is Rest Display Name.spec_type.enum_values.values.id: grpc-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 spec_type attribute is
grpc-id and the spec was created before 2021-08-15 14:50:00 UTC and
after 2021-08-10 12:00:00 UTC.spec_type.enum_values.values.id: rest-id OR
spec_type.enum_values.values.id: grpc-id- The id of the allowed value associated with the spec_type attribute is
rest-id or grpc-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 Specs.
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 Spec are eligible for filtering:
display_name - The display name of the Spec. Allowed comparison
operators: =.create_time - The time at which the Spec was created. The
value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
format. Allowed comparison operators: > and <.spec_type.enum_values.values.id - The allowed value id of the
spec_type attribute associated with the Spec. Allowed comparison
operators: :.spec_type.enum_values.values.display_name - The allowed value display
name of the spec_type attribute associated with the Spec. Allowed
comparison operators: :.lint_response.json_values.values - The json value of the
lint_response attribute associated with the Spec. Allowed comparison
operators: :.mime_type - The MIME type of the Spec. 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:
spec_type.enum_values.values.id: rest-id - The filter
string specifies that the id of the allowed value associated with the
spec_type attribute is rest-id.
spec_type.enum_values.values.display_name: \"Rest Display Name\" -
The filter string specifies that the display name of the allowed value
associated with the spec_type attribute is Rest Display Name.spec_type.enum_values.values.id: grpc-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 spec_type attribute is
grpc-id and the spec was created before 2021-08-15 14:50:00 UTC and
after 2021-08-10 12:00:00 UTC.spec_type.enum_values.values.id: rest-id OR
spec_type.enum_values.values.id: grpc-id- The id of the allowed value associated with the spec_type attribute is
rest-id or grpc-id.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for filter.
|
getPageSize()
Optional. The maximum number of specs to return. The service may return
fewer than this value. If unspecified, at most 50 specs 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 ListSpecs call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListSpecs 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 ListSpecs call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListSpecs 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 specs.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}
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 specs.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
getParserForType()
public Parser<ListSpecsRequest> 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 ListSpecsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListSpecsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ListSpecsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
