Package com.authzed.api.v1

Class DeleteRelationshipsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.authzed.api.v1.DeleteRelationshipsRequest
All Implemented Interfaces:
DeleteRelationshipsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DeleteRelationshipsRequest extends com.google.protobuf.GeneratedMessage implements DeleteRelationshipsRequestOrBuilder
 DeleteRelationshipsRequest specifies which Relationships should be deleted,
 requesting the delete of *ALL* relationships that match the specified
 filters. If the optional_preconditions parameter is included, all of the
 specified preconditions must also be satisfied before the delete will be
 executed.
Protobuf type authzed.api.v1.DeleteRelationshipsRequest
See Also:

  • Field Details

    • RELATIONSHIP_FILTER_FIELD_NUMBER

      public static final int RELATIONSHIP_FILTER_FIELD_NUMBER
      See Also:

    • OPTIONAL_PRECONDITIONS_FIELD_NUMBER

      public static final int OPTIONAL_PRECONDITIONS_FIELD_NUMBER
      See Also:

    • OPTIONAL_LIMIT_FIELD_NUMBER

      public static final int OPTIONAL_LIMIT_FIELD_NUMBER
      See Also:

    • OPTIONAL_ALLOW_PARTIAL_DELETIONS_FIELD_NUMBER

      public static final int OPTIONAL_ALLOW_PARTIAL_DELETIONS_FIELD_NUMBER
      See Also:

    • OPTIONAL_TRANSACTION_METADATA_FIELD_NUMBER

      public static final int OPTIONAL_TRANSACTION_METADATA_FIELD_NUMBER
      See Also:

  • 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

    • hasRelationshipFilter

      public boolean hasRelationshipFilter()
      .authzed.api.v1.RelationshipFilter relationship_filter = 1 [(.validate.rules) = { ... }
      Specified by:
      hasRelationshipFilter in interface DeleteRelationshipsRequestOrBuilder
      Returns:
      Whether the relationshipFilter field is set.

    • getRelationshipFilter

      public RelationshipFilter getRelationshipFilter()
      .authzed.api.v1.RelationshipFilter relationship_filter = 1 [(.validate.rules) = { ... }
      Specified by:
      getRelationshipFilter in interface DeleteRelationshipsRequestOrBuilder
      Returns:
      The relationshipFilter.

    • getRelationshipFilterOrBuilder

      public RelationshipFilterOrBuilder getRelationshipFilterOrBuilder()
      .authzed.api.v1.RelationshipFilter relationship_filter = 1 [(.validate.rules) = { ... }
      Specified by:
      getRelationshipFilterOrBuilder in interface DeleteRelationshipsRequestOrBuilder

    • getOptionalPreconditionsList

      public List<Precondition> getOptionalPreconditionsList()
       To be bounded by configuration
      repeated .authzed.api.v1.Precondition optional_preconditions = 2 [(.validate.rules) = { ... }
      Specified by:
      getOptionalPreconditionsList in interface DeleteRelationshipsRequestOrBuilder

    • getOptionalPreconditionsOrBuilderList

      public List<? extends PreconditionOrBuilder> getOptionalPreconditionsOrBuilderList()
       To be bounded by configuration
      repeated .authzed.api.v1.Precondition optional_preconditions = 2 [(.validate.rules) = { ... }
      Specified by:
      getOptionalPreconditionsOrBuilderList in interface DeleteRelationshipsRequestOrBuilder

    • getOptionalPreconditionsCount

      public int getOptionalPreconditionsCount()
       To be bounded by configuration
      repeated .authzed.api.v1.Precondition optional_preconditions = 2 [(.validate.rules) = { ... }
      Specified by:
      getOptionalPreconditionsCount in interface DeleteRelationshipsRequestOrBuilder

    • getOptionalPreconditions

      public Precondition getOptionalPreconditions(int index)
       To be bounded by configuration
      repeated .authzed.api.v1.Precondition optional_preconditions = 2 [(.validate.rules) = { ... }
      Specified by:
      getOptionalPreconditions in interface DeleteRelationshipsRequestOrBuilder

    • getOptionalPreconditionsOrBuilder

      public PreconditionOrBuilder getOptionalPreconditionsOrBuilder(int index)
       To be bounded by configuration
      repeated .authzed.api.v1.Precondition optional_preconditions = 2 [(.validate.rules) = { ... }
      Specified by:
      getOptionalPreconditionsOrBuilder in interface DeleteRelationshipsRequestOrBuilder

    • getOptionalLimit

      public int getOptionalLimit()
       optional_limit, if non-zero, specifies the limit on the number of relationships to be deleted.
 If there are more matching relationships found to be deleted than the limit specified here,
 the deletion call will fail with an error to prevent partial deletion. If partial deletion
 is needed, specify below that partial deletion is allowed. Partial deletions can be used
 in a loop to delete large amounts of relationships in a *non-transactional* manner.
      uint32 optional_limit = 3 [(.validate.rules) = { ... }
      Specified by:
      getOptionalLimit in interface DeleteRelationshipsRequestOrBuilder
      Returns:
      The optionalLimit.

    • getOptionalAllowPartialDeletions

      public boolean getOptionalAllowPartialDeletions()
       optional_allow_partial_deletions, if true and a limit is specified, will delete matching found
 relationships up to the count specified in optional_limit, and no more.
      bool optional_allow_partial_deletions = 4;
      Specified by:
      getOptionalAllowPartialDeletions in interface DeleteRelationshipsRequestOrBuilder
      Returns:
      The optionalAllowPartialDeletions.

    • hasOptionalTransactionMetadata

      public boolean hasOptionalTransactionMetadata()
       optional_transaction_metadata is an optional field that can be used to store metadata about the transaction.
 If specified, this metadata will be supplied in the WatchResponse for the deletions associated with
 this transaction.
      .google.protobuf.Struct optional_transaction_metadata = 5 [(.validate.rules) = { ... }
      Specified by:
      hasOptionalTransactionMetadata in interface DeleteRelationshipsRequestOrBuilder
      Returns:
      Whether the optionalTransactionMetadata field is set.

    • getOptionalTransactionMetadata

      public com.google.protobuf.Struct getOptionalTransactionMetadata()
       optional_transaction_metadata is an optional field that can be used to store metadata about the transaction.
 If specified, this metadata will be supplied in the WatchResponse for the deletions associated with
 this transaction.
      .google.protobuf.Struct optional_transaction_metadata = 5 [(.validate.rules) = { ... }
      Specified by:
      getOptionalTransactionMetadata in interface DeleteRelationshipsRequestOrBuilder
      Returns:
      The optionalTransactionMetadata.

    • getOptionalTransactionMetadataOrBuilder

      public com.google.protobuf.StructOrBuilder getOptionalTransactionMetadataOrBuilder()
       optional_transaction_metadata is an optional field that can be used to store metadata about the transaction.
 If specified, this metadata will be supplied in the WatchResponse for the deletions associated with
 this transaction.
      .google.protobuf.Struct optional_transaction_metadata = 5 [(.validate.rules) = { ... }
      Specified by:
      getOptionalTransactionMetadataOrBuilder in interface DeleteRelationshipsRequestOrBuilder

    • 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 DeleteRelationshipsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static DeleteRelationshipsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static DeleteRelationshipsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DeleteRelationshipsRequest.Builder newBuilder()

    • newBuilder

      public static DeleteRelationshipsRequest.Builder newBuilder(DeleteRelationshipsRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DeleteRelationshipsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DeleteRelationshipsRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<DeleteRelationshipsRequest> 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 DeleteRelationshipsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder