Package com.authzed.api.v1

Class Relationship

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.authzed.api.v1.Relationship
All Implemented Interfaces:
RelationshipOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Relationship extends com.google.protobuf.GeneratedMessage implements RelationshipOrBuilder
 Relationship specifies how a resource relates to a subject. Relationships
 form the data for the graph over which all permissions questions are
 answered.
Protobuf type authzed.api.v1.Relationship
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Relationship.Builder
    Relationship specifies how a resource relates to a subject.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    OPTIONAL_CAVEAT_FIELD_NUMBER
     
    static final int
    OPTIONAL_EXPIRES_AT_FIELD_NUMBER
     
    static final int
    RELATION_FIELD_NUMBER
     
    static final int
    RESOURCE_FIELD_NUMBER
     
    static final int
    SUBJECT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Relationship
    getDefaultInstance()
     
    Relationship
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    ContextualizedCaveat
    getOptionalCaveat()
    optional_caveat is a reference to a the caveat that must be enforced over the relationship
    ContextualizedCaveatOrBuilder
    getOptionalCaveatOrBuilder()
    optional_caveat is a reference to a the caveat that must be enforced over the relationship
    com.google.protobuf.Timestamp
    getOptionalExpiresAt()
    optional_expires_at is the time at which the relationship expires, if any.
    com.google.protobuf.TimestampOrBuilder
    getOptionalExpiresAtOrBuilder()
    optional_expires_at is the time at which the relationship expires, if any.
    com.google.protobuf.Parser<Relationship>
    getParserForType()
     
    String
    getRelation()
    relation is how the resource and subject are related.
    com.google.protobuf.ByteString
    getRelationBytes()
    relation is how the resource and subject are related.
    ObjectReference
    getResource()
    resource is the resource to which the subject is related, in some manner
    ObjectReferenceOrBuilder
    getResourceOrBuilder()
    resource is the resource to which the subject is related, in some manner
    int
    getSerializedSize()
     
    SubjectReference
    getSubject()
    subject is the subject to which the resource is related, in some manner.
    SubjectReferenceOrBuilder
    getSubjectOrBuilder()
    subject is the subject to which the resource is related, in some manner.
    int
    hashCode()
     
    boolean
    hasOptionalCaveat()
    optional_caveat is a reference to a the caveat that must be enforced over the relationship
    boolean
    hasOptionalExpiresAt()
    optional_expires_at is the time at which the relationship expires, if any.
    boolean
    hasResource()
    resource is the resource to which the subject is related, in some manner
    boolean
    hasSubject()
    subject is the subject to which the resource is related, in some manner.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Relationship.Builder
    newBuilder()
     
    static Relationship.Builder
    newBuilder(Relationship prototype)
     
    Relationship.Builder
    newBuilderForType()
     
    protected Relationship.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Relationship
    parseDelimitedFrom(InputStream input)
     
    static Relationship
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Relationship
    parseFrom(byte[] data)
     
    static Relationship
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Relationship
    parseFrom(com.google.protobuf.ByteString data)
     
    static Relationship
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Relationship
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Relationship
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Relationship
    parseFrom(InputStream input)
     
    static Relationship
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Relationship
    parseFrom(ByteBuffer data)
     
    static Relationship
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Relationship>
    parser()
     
    Relationship.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • RESOURCE_FIELD_NUMBER

      public static final int RESOURCE_FIELD_NUMBER
      See Also:

    • RELATION_FIELD_NUMBER

      public static final int RELATION_FIELD_NUMBER
      See Also:

    • SUBJECT_FIELD_NUMBER

      public static final int SUBJECT_FIELD_NUMBER
      See Also:

    • OPTIONAL_CAVEAT_FIELD_NUMBER

      public static final int OPTIONAL_CAVEAT_FIELD_NUMBER
      See Also:

    • OPTIONAL_EXPIRES_AT_FIELD_NUMBER

      public static final int OPTIONAL_EXPIRES_AT_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

    • hasResource

      public boolean hasResource()
       resource is the resource to which the subject is related, in some manner
      .authzed.api.v1.ObjectReference resource = 1 [(.validate.rules) = { ... }
      Specified by:
      hasResource in interface RelationshipOrBuilder
      Returns:
      Whether the resource field is set.

    • getResource

      public ObjectReference getResource()
       resource is the resource to which the subject is related, in some manner
      .authzed.api.v1.ObjectReference resource = 1 [(.validate.rules) = { ... }
      Specified by:
      getResource in interface RelationshipOrBuilder
      Returns:
      The resource.

    • getResourceOrBuilder

      public ObjectReferenceOrBuilder getResourceOrBuilder()
       resource is the resource to which the subject is related, in some manner
      .authzed.api.v1.ObjectReference resource = 1 [(.validate.rules) = { ... }
      Specified by:
      getResourceOrBuilder in interface RelationshipOrBuilder

    • getRelation

      public String getRelation()
       relation is how the resource and subject are related.
      string relation = 2 [(.validate.rules) = { ... }
      Specified by:
      getRelation in interface RelationshipOrBuilder
      Returns:
      The relation.

    • getRelationBytes

      public com.google.protobuf.ByteString getRelationBytes()
       relation is how the resource and subject are related.
      string relation = 2 [(.validate.rules) = { ... }
      Specified by:
      getRelationBytes in interface RelationshipOrBuilder
      Returns:
      The bytes for relation.

    • hasSubject

      public boolean hasSubject()
       subject is the subject to which the resource is related, in some manner.
      .authzed.api.v1.SubjectReference subject = 3 [(.validate.rules) = { ... }
      Specified by:
      hasSubject in interface RelationshipOrBuilder
      Returns:
      Whether the subject field is set.

    • getSubject

      public SubjectReference getSubject()
       subject is the subject to which the resource is related, in some manner.
      .authzed.api.v1.SubjectReference subject = 3 [(.validate.rules) = { ... }
      Specified by:
      getSubject in interface RelationshipOrBuilder
      Returns:
      The subject.

    • getSubjectOrBuilder

      public SubjectReferenceOrBuilder getSubjectOrBuilder()
       subject is the subject to which the resource is related, in some manner.
      .authzed.api.v1.SubjectReference subject = 3 [(.validate.rules) = { ... }
      Specified by:
      getSubjectOrBuilder in interface RelationshipOrBuilder

    • hasOptionalCaveat

      public boolean hasOptionalCaveat()
       optional_caveat is a reference to a the caveat that must be enforced over the relationship
      .authzed.api.v1.ContextualizedCaveat optional_caveat = 4 [(.validate.rules) = { ... }
      Specified by:
      hasOptionalCaveat in interface RelationshipOrBuilder
      Returns:
      Whether the optionalCaveat field is set.

    • getOptionalCaveat

      public ContextualizedCaveat getOptionalCaveat()
       optional_caveat is a reference to a the caveat that must be enforced over the relationship
      .authzed.api.v1.ContextualizedCaveat optional_caveat = 4 [(.validate.rules) = { ... }
      Specified by:
      getOptionalCaveat in interface RelationshipOrBuilder
      Returns:
      The optionalCaveat.

    • getOptionalCaveatOrBuilder

      public ContextualizedCaveatOrBuilder getOptionalCaveatOrBuilder()
       optional_caveat is a reference to a the caveat that must be enforced over the relationship
      .authzed.api.v1.ContextualizedCaveat optional_caveat = 4 [(.validate.rules) = { ... }
      Specified by:
      getOptionalCaveatOrBuilder in interface RelationshipOrBuilder

    • hasOptionalExpiresAt

      public boolean hasOptionalExpiresAt()
       optional_expires_at is the time at which the relationship expires, if any.
      .google.protobuf.Timestamp optional_expires_at = 5;
      Specified by:
      hasOptionalExpiresAt in interface RelationshipOrBuilder
      Returns:
      Whether the optionalExpiresAt field is set.

    • getOptionalExpiresAt

      public com.google.protobuf.Timestamp getOptionalExpiresAt()
       optional_expires_at is the time at which the relationship expires, if any.
      .google.protobuf.Timestamp optional_expires_at = 5;
      Specified by:
      getOptionalExpiresAt in interface RelationshipOrBuilder
      Returns:
      The optionalExpiresAt.

    • getOptionalExpiresAtOrBuilder

      public com.google.protobuf.TimestampOrBuilder getOptionalExpiresAtOrBuilder()
       optional_expires_at is the time at which the relationship expires, if any.
      .google.protobuf.Timestamp optional_expires_at = 5;
      Specified by:
      getOptionalExpiresAtOrBuilder in interface RelationshipOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Relationship.Builder newBuilder()

    • newBuilder

      public static Relationship.Builder newBuilder(Relationship prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Relationship getDefaultInstance()

    • parser

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

    • getParserForType

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