Class ListDependenciesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.apihub.v1.ListDependenciesRequest
All Implemented Interfaces:
ListDependenciesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class ListDependenciesRequest extends com.google.protobuf.GeneratedMessage implements ListDependenciesRequestOrBuilder
 The
 [ListDependencies][google.cloud.apihub.v1.ApiHubDependencies.ListDependencies]
 method's request.
 
Protobuf type google.cloud.apihub.v1.ListDependenciesRequest
See Also:
  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • 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) = { ... }
      Specified by:
      getParent in interface ListDependenciesRequestOrBuilder
      Returns:
      The parent.
    • getParentBytes

      public 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) = { ... }
      Specified by:
      getParentBytes in interface ListDependenciesRequestOrBuilder
      Returns:
      The bytes for parent.
    • 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];
      Specified by:
      getFilter in interface ListDependenciesRequestOrBuilder
      Returns:
      The filter.
    • getFilterBytes

      public 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];
      Specified by:
      getFilterBytes in interface ListDependenciesRequestOrBuilder
      Returns:
      The bytes for filter.
    • getPageSize

      public 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];
      Specified by:
      getPageSize in interface ListDependenciesRequestOrBuilder
      Returns:
      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];
      Specified by:
      getPageToken in interface ListDependenciesRequestOrBuilder
      Returns:
      The pageToken.
    • getPageTokenBytes

      public 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];
      Specified by:
      getPageTokenBytes in interface ListDependenciesRequestOrBuilder
      Returns:
      The bytes for pageToken.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static ListDependenciesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ListDependenciesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ListDependenciesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ListDependenciesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ListDependenciesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ListDependenciesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ListDependenciesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ListDependenciesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ListDependenciesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ListDependenciesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ListDependenciesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ListDependenciesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public ListDependenciesRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static ListDependenciesRequest.Builder newBuilder()
    • newBuilder

      public static ListDependenciesRequest.Builder newBuilder(ListDependenciesRequest prototype)
    • toBuilder

      public ListDependenciesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected ListDependenciesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static ListDependenciesRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<ListDependenciesRequest> parser()
    • getParserForType

      public com.google.protobuf.Parser<ListDependenciesRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public ListDependenciesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder