public interface ListDependenciesRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getFilter()
public abstract 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
ANDlogic operator orORlogical operator but not both of them together i.e. only one of theANDorORoperator 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_ARGUMENTerror 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 abstract 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
ANDlogic operator orORlogical operator but not both of them together i.e. only one of theANDorORoperator 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_ARGUMENTerror 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()
public abstract int 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 abstract 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 abstract 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 abstract 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 abstract 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. |