public final class ListDependenciesRequest extends GeneratedMessageV3 implements ListDependenciesRequestOrBuilder
The
ListDependencies
method's request.
Protobuf type google.cloud.apihub.v1.ListDependenciesRequest
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 ListDependenciesRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListDependenciesRequest.Builder newBuilder()
newBuilder(ListDependenciesRequest prototype)
public static ListDependenciesRequest.Builder newBuilder(ListDependenciesRequest prototype)
public static ListDependenciesRequest parseDelimitedFrom(InputStream input)
public static ListDependenciesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListDependenciesRequest parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListDependenciesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListDependenciesRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListDependenciesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListDependenciesRequest parseFrom(CodedInputStream input)
public static ListDependenciesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListDependenciesRequest parseFrom(InputStream input)
public static ListDependenciesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListDependenciesRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListDependenciesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListDependenciesRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListDependenciesRequest getDefaultInstanceForType()
getFilter()
public String getFilter()
Optional. An expression that filters the list of Dependencies.
A filter expression consists of a field name, a comparison operator, and
a value for filtering. The value must be a string. Allowed comparison
operator is =
. Filters are not case sensitive.
The following fields in the Dependency
are eligible for filtering:
consumer.operation_resource_name
- The operation resource name for
the consumer entity involved in a dependency. Allowed comparison
operators: =
.
consumer.external_api_resource_name
- The external api resource name
for the consumer entity involved in a dependency. Allowed comparison
operators: =
.
supplier.operation_resource_name
- The operation resource name for
the supplier entity involved in a dependency. Allowed comparison
operators: =
.
supplier.external_api_resource_name
- The external api resource name
for the supplier entity involved in a dependency. 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.
For example, consumer.operation_resource_name =
\"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\" OR
supplier.operation_resource_name =
\"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\"
- The
dependencies with either consumer or supplier operation resource name as
projects/p1/locations/global/apis/a1/versions/v1/operations/o1.
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 Dependencies.
A filter expression consists of a field name, a comparison operator, and
a value for filtering. The value must be a string. Allowed comparison
operator is =
. Filters are not case sensitive.
The following fields in the Dependency
are eligible for filtering:
consumer.operation_resource_name
- The operation resource name for
the consumer entity involved in a dependency. Allowed comparison
operators: =
.
consumer.external_api_resource_name
- The external api resource name
for the consumer entity involved in a dependency. Allowed comparison
operators: =
.
supplier.operation_resource_name
- The operation resource name for
the supplier entity involved in a dependency. Allowed comparison
operators: =
.
supplier.external_api_resource_name
- The external api resource name
for the supplier entity involved in a dependency. 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.
For example, consumer.operation_resource_name =
\"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\" OR
supplier.operation_resource_name =
\"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\"
- The
dependencies with either consumer or supplier operation resource name as
projects/p1/locations/global/apis/a1/versions/v1/operations/o1.
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
ByteString |
The bytes for filter.
|
getPageSize()
Optional. The maximum number of dependency resources to return. The service
may return fewer than this value. If unspecified, at most 50 dependencies
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 ListDependencies
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListDependencies
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 ListDependencies
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListDependencies
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 dependency resources.
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 which owns this collection of dependency resources.
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.
|
getParserForType()
public Parser<ListDependenciesRequest> 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 ListDependenciesRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListDependenciesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public ListDependenciesRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides