public final class ListApiOperationsRequest extends GeneratedMessageV3 implements ListApiOperationsRequestOrBuilder
The ListApiOperations
method's request.
Protobuf type google.cloud.apihub.v1.ListApiOperationsRequest
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 ListApiOperationsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListApiOperationsRequest.Builder newBuilder()
newBuilder(ListApiOperationsRequest prototype)
public static ListApiOperationsRequest.Builder newBuilder(ListApiOperationsRequest prototype)
public static ListApiOperationsRequest parseDelimitedFrom(InputStream input)
public static ListApiOperationsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListApiOperationsRequest parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListApiOperationsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListApiOperationsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListApiOperationsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListApiOperationsRequest parseFrom(CodedInputStream input)
public static ListApiOperationsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListApiOperationsRequest parseFrom(InputStream input)
public static ListApiOperationsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListApiOperationsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListApiOperationsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListApiOperationsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListApiOperationsRequest getDefaultInstanceForType()
getFilter()
public String getFilter()
Optional. An expression that filters the list of ApiOperations.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string or a
boolean. The comparison operator must be one of: <
, >
or
=
. Filters are not case sensitive.
The following fields in the ApiOperation
are eligible for filtering:
name
- The ApiOperation resource name. Allowed comparison
operators:
=
.
details.http_operation.path.path
- The http operation's complete path
relative to server endpoint. Allowed comparison operators: =
.
details.http_operation.method
- The http operation method type.
Allowed comparison operators: =
.
details.deprecated
- Indicates if the ApiOperation is deprecated.
Allowed values are True / False indicating the deprycation status of the
ApiOperation. Allowed comparison operators: =
.
create_time
- The time at which the ApiOperation was created. The
value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
format. Allowed comparison operators: >
and <
.
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:
details.deprecated = True
- The ApiOperation is deprecated.
details.http_operation.method = GET AND create_time <
\"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"
-
The method of the http operation of the ApiOperation is GET and the
spec was created before 2021-08-15 14:50:00 UTC and after 2021-08-10
12:00:00 UTC.
details.http_operation.method = GET OR details.http_operation.method =
POST
. - The http operation of the method of ApiOperation is GET or
POST.
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 ApiOperations.
A filter expression consists of a field name, a comparison
operator, and a value for filtering. The value must be a string or a
boolean. The comparison operator must be one of: <
, >
or
=
. Filters are not case sensitive.
The following fields in the ApiOperation
are eligible for filtering:
name
- The ApiOperation resource name. Allowed comparison
operators:
=
.
details.http_operation.path.path
- The http operation's complete path
relative to server endpoint. Allowed comparison operators: =
.
details.http_operation.method
- The http operation method type.
Allowed comparison operators: =
.
details.deprecated
- Indicates if the ApiOperation is deprecated.
Allowed values are True / False indicating the deprycation status of the
ApiOperation. Allowed comparison operators: =
.
create_time
- The time at which the ApiOperation was created. The
value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339]
format. Allowed comparison operators: >
and <
.
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:
details.deprecated = True
- The ApiOperation is deprecated.
details.http_operation.method = GET AND create_time <
\"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"
-
The method of the http operation of the ApiOperation is GET and the
spec was created before 2021-08-15 14:50:00 UTC and after 2021-08-10
12:00:00 UTC.
details.http_operation.method = GET OR details.http_operation.method =
POST
. - The http operation of the method of ApiOperation is GET or
POST.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
ByteString |
The bytes for filter.
|
getPageSize()
Optional. The maximum number of operations to return. The service may
return fewer than this value. If unspecified, at most 50 operations 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 ListApiOperations
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListApiOperations
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 ListApiOperations
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters (except page_size) provided to
ListApiOperations
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 operations i.e., the API
version. 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 operations i.e., the API
version. 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<ListApiOperationsRequest> 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 ListApiOperationsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListApiOperationsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public ListApiOperationsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides