Package com.authzed.api.v1

Interface RelationshipOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Relationship, Relationship.Builder
public interface RelationshipOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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
    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.
    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.

    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

    • hasResource

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

    • getResource

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

    • getResourceOrBuilder

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

    • getRelation

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

    • getRelationBytes

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

    • hasSubject

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

    • getSubject

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

    • getSubjectOrBuilder

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

    • hasOptionalCaveat

      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) = { ... }
      Returns:
      Whether the optionalCaveat field is set.

    • getOptionalCaveat

      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) = { ... }
      Returns:
      The optionalCaveat.

    • getOptionalCaveatOrBuilder

      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) = { ... }

    • hasOptionalExpiresAt

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

    • getOptionalExpiresAt

      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;
      Returns:
      The optionalExpiresAt.

    • getOptionalExpiresAtOrBuilder

      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;