Interface ListDependenciesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListDependenciesRequest, ListDependenciesRequest.Builder

@Generated public interface ListDependenciesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    Optional.
    com.google.protobuf.ByteString
    Optional.
    int
    Optional.
    Optional.
    com.google.protobuf.ByteString
    Optional.
    Required.
    com.google.protobuf.ByteString
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • getParent

      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:
      The parent.
    • getParentBytes

      com.google.protobuf.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:
      The bytes for parent.
    • getFilter

      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:
      The filter.
    • getFilterBytes

      com.google.protobuf.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:
      The bytes for filter.
    • getPageSize

      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:
      The pageSize.
    • getPageToken

      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:
      The pageToken.
    • getPageTokenBytes

      com.google.protobuf.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:
      The bytes for pageToken.