Package com.authzed.api.v1
Class LookupResourcesRequest.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<LookupResourcesRequest.Builder>
com.authzed.api.v1.LookupResourcesRequest.Builder
- All Implemented Interfaces:
LookupResourcesRequestOrBuilder
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Cloneable
- Enclosing class:
- LookupResourcesRequest
public static final class LookupResourcesRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<LookupResourcesRequest.Builder>
implements LookupResourcesRequestOrBuilder
LookupResourcesRequest performs a lookup of all resources of a particular kind on which the subject has the specified permission or the relation in which the subject exists, streaming back the IDs of those resources.Protobuf type
authzed.api.v1.LookupResourcesRequest
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
clear()
.authzed.api.v1.Consistency consistency = 1;
context consists of named values that are injected into the caveat evaluation contextoptional_cursor, if specified, indicates the cursor after which results should resume being returned.optional_limit, if non-zero, specifies the limit on the number of resources to return before the stream is closed on the server side.permission is the name of the permission or relation for which the subject must Check.resource_object_type is the type of resource object for which the IDs will be returned.subject is the subject with access to the resources..authzed.api.v1.Consistency consistency = 1;
.authzed.api.v1.Consistency consistency = 1;
.authzed.api.v1.Consistency consistency = 1;
com.google.protobuf.Struct
context consists of named values that are injected into the caveat evaluation contextcom.google.protobuf.Struct.Builder
context consists of named values that are injected into the caveat evaluation contextcom.google.protobuf.StructOrBuilder
context consists of named values that are injected into the caveat evaluation contextstatic final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
optional_cursor, if specified, indicates the cursor after which results should resume being returned.optional_cursor, if specified, indicates the cursor after which results should resume being returned.optional_cursor, if specified, indicates the cursor after which results should resume being returned.int
optional_limit, if non-zero, specifies the limit on the number of resources to return before the stream is closed on the server side.permission is the name of the permission or relation for which the subject must Check.com.google.protobuf.ByteString
permission is the name of the permission or relation for which the subject must Check.resource_object_type is the type of resource object for which the IDs will be returned.com.google.protobuf.ByteString
resource_object_type is the type of resource object for which the IDs will be returned.subject is the subject with access to the resources.subject is the subject with access to the resources.subject is the subject with access to the resources.boolean
.authzed.api.v1.Consistency consistency = 1;
boolean
context consists of named values that are injected into the caveat evaluation contextboolean
optional_cursor, if specified, indicates the cursor after which results should resume being returned.boolean
subject is the subject with access to the resources.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
mergeConsistency
(Consistency value) .authzed.api.v1.Consistency consistency = 1;
mergeContext
(com.google.protobuf.Struct value) context consists of named values that are injected into the caveat evaluation contextmergeFrom
(LookupResourcesRequest other) mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeOptionalCursor
(Cursor value) optional_cursor, if specified, indicates the cursor after which results should resume being returned.mergeSubject
(SubjectReference value) subject is the subject with access to the resources.setConsistency
(Consistency value) .authzed.api.v1.Consistency consistency = 1;
setConsistency
(Consistency.Builder builderForValue) .authzed.api.v1.Consistency consistency = 1;
setContext
(com.google.protobuf.Struct value) context consists of named values that are injected into the caveat evaluation contextsetContext
(com.google.protobuf.Struct.Builder builderForValue) context consists of named values that are injected into the caveat evaluation contextsetOptionalCursor
(Cursor value) optional_cursor, if specified, indicates the cursor after which results should resume being returned.setOptionalCursor
(Cursor.Builder builderForValue) optional_cursor, if specified, indicates the cursor after which results should resume being returned.setOptionalLimit
(int value) optional_limit, if non-zero, specifies the limit on the number of resources to return before the stream is closed on the server side.setPermission
(String value) permission is the name of the permission or relation for which the subject must Check.setPermissionBytes
(com.google.protobuf.ByteString value) permission is the name of the permission or relation for which the subject must Check.setResourceObjectType
(String value) resource_object_type is the type of resource object for which the IDs will be returned.setResourceObjectTypeBytes
(com.google.protobuf.ByteString value) resource_object_type is the type of resource object for which the IDs will be returned.setSubject
(SubjectReference value) subject is the subject with access to the resources.setSubject
(SubjectReference.Builder builderForValue) subject is the subject with access to the resources.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage.Builder<LookupResourcesRequest.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessage.Builder<LookupResourcesRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<LookupResourcesRequest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<LookupResourcesRequest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.Builder<LookupResourcesRequest.Builder>
-
mergeFrom
public LookupResourcesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<LookupResourcesRequest.Builder>
- Throws:
IOException
-
hasConsistency
public boolean hasConsistency().authzed.api.v1.Consistency consistency = 1;
- Specified by:
hasConsistency
in interfaceLookupResourcesRequestOrBuilder
- Returns:
- Whether the consistency field is set.
-
getConsistency
.authzed.api.v1.Consistency consistency = 1;
- Specified by:
getConsistency
in interfaceLookupResourcesRequestOrBuilder
- Returns:
- The consistency.
-
setConsistency
.authzed.api.v1.Consistency consistency = 1;
-
setConsistency
.authzed.api.v1.Consistency consistency = 1;
-
mergeConsistency
.authzed.api.v1.Consistency consistency = 1;
-
clearConsistency
.authzed.api.v1.Consistency consistency = 1;
-
getConsistencyBuilder
.authzed.api.v1.Consistency consistency = 1;
-
getConsistencyOrBuilder
.authzed.api.v1.Consistency consistency = 1;
- Specified by:
getConsistencyOrBuilder
in interfaceLookupResourcesRequestOrBuilder
-
getResourceObjectType
resource_object_type is the type of resource object for which the IDs will be returned.
string resource_object_type = 2 [(.validate.rules) = { ... }
- Specified by:
getResourceObjectType
in interfaceLookupResourcesRequestOrBuilder
- Returns:
- The resourceObjectType.
-
getResourceObjectTypeBytes
public com.google.protobuf.ByteString getResourceObjectTypeBytes()resource_object_type is the type of resource object for which the IDs will be returned.
string resource_object_type = 2 [(.validate.rules) = { ... }
- Specified by:
getResourceObjectTypeBytes
in interfaceLookupResourcesRequestOrBuilder
- Returns:
- The bytes for resourceObjectType.
-
setResourceObjectType
resource_object_type is the type of resource object for which the IDs will be returned.
string resource_object_type = 2 [(.validate.rules) = { ... }
- Parameters:
value
- The resourceObjectType to set.- Returns:
- This builder for chaining.
-
clearResourceObjectType
resource_object_type is the type of resource object for which the IDs will be returned.
string resource_object_type = 2 [(.validate.rules) = { ... }
- Returns:
- This builder for chaining.
-
setResourceObjectTypeBytes
public LookupResourcesRequest.Builder setResourceObjectTypeBytes(com.google.protobuf.ByteString value) resource_object_type is the type of resource object for which the IDs will be returned.
string resource_object_type = 2 [(.validate.rules) = { ... }
- Parameters:
value
- The bytes for resourceObjectType to set.- Returns:
- This builder for chaining.
-
getPermission
permission is the name of the permission or relation for which the subject must Check.
string permission = 3 [(.validate.rules) = { ... }
- Specified by:
getPermission
in interfaceLookupResourcesRequestOrBuilder
- Returns:
- The permission.
-
getPermissionBytes
public com.google.protobuf.ByteString getPermissionBytes()permission is the name of the permission or relation for which the subject must Check.
string permission = 3 [(.validate.rules) = { ... }
- Specified by:
getPermissionBytes
in interfaceLookupResourcesRequestOrBuilder
- Returns:
- The bytes for permission.
-
setPermission
permission is the name of the permission or relation for which the subject must Check.
string permission = 3 [(.validate.rules) = { ... }
- Parameters:
value
- The permission to set.- Returns:
- This builder for chaining.
-
clearPermission
permission is the name of the permission or relation for which the subject must Check.
string permission = 3 [(.validate.rules) = { ... }
- Returns:
- This builder for chaining.
-
setPermissionBytes
permission is the name of the permission or relation for which the subject must Check.
string permission = 3 [(.validate.rules) = { ... }
- Parameters:
value
- The bytes for permission to set.- Returns:
- This builder for chaining.
-
hasSubject
public boolean hasSubject()subject is the subject with access to the resources.
.authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
- Specified by:
hasSubject
in interfaceLookupResourcesRequestOrBuilder
- Returns:
- Whether the subject field is set.
-
getSubject
subject is the subject with access to the resources.
.authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
- Specified by:
getSubject
in interfaceLookupResourcesRequestOrBuilder
- Returns:
- The subject.
-
setSubject
subject is the subject with access to the resources.
.authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
-
setSubject
subject is the subject with access to the resources.
.authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
-
mergeSubject
subject is the subject with access to the resources.
.authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
-
clearSubject
subject is the subject with access to the resources.
.authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
-
getSubjectBuilder
subject is the subject with access to the resources.
.authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
-
getSubjectOrBuilder
subject is the subject with access to the resources.
.authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
- Specified by:
getSubjectOrBuilder
in interfaceLookupResourcesRequestOrBuilder
-
hasContext
public boolean hasContext()context consists of named values that are injected into the caveat evaluation context
.google.protobuf.Struct context = 5 [(.validate.rules) = { ... }
- Specified by:
hasContext
in interfaceLookupResourcesRequestOrBuilder
- Returns:
- Whether the context field is set.
-
getContext
public com.google.protobuf.Struct getContext()context consists of named values that are injected into the caveat evaluation context
.google.protobuf.Struct context = 5 [(.validate.rules) = { ... }
- Specified by:
getContext
in interfaceLookupResourcesRequestOrBuilder
- Returns:
- The context.
-
setContext
context consists of named values that are injected into the caveat evaluation context
.google.protobuf.Struct context = 5 [(.validate.rules) = { ... }
-
setContext
public LookupResourcesRequest.Builder setContext(com.google.protobuf.Struct.Builder builderForValue) context consists of named values that are injected into the caveat evaluation context
.google.protobuf.Struct context = 5 [(.validate.rules) = { ... }
-
mergeContext
context consists of named values that are injected into the caveat evaluation context
.google.protobuf.Struct context = 5 [(.validate.rules) = { ... }
-
clearContext
context consists of named values that are injected into the caveat evaluation context
.google.protobuf.Struct context = 5 [(.validate.rules) = { ... }
-
getContextBuilder
public com.google.protobuf.Struct.Builder getContextBuilder()context consists of named values that are injected into the caveat evaluation context
.google.protobuf.Struct context = 5 [(.validate.rules) = { ... }
-
getContextOrBuilder
public com.google.protobuf.StructOrBuilder getContextOrBuilder()context consists of named values that are injected into the caveat evaluation context
.google.protobuf.Struct context = 5 [(.validate.rules) = { ... }
- Specified by:
getContextOrBuilder
in interfaceLookupResourcesRequestOrBuilder
-
getOptionalLimit
public int getOptionalLimit()optional_limit, if non-zero, specifies the limit on the number of resources to return before the stream is closed on the server side. By default, the stream will continue resolving resources until exhausted or the stream is closed due to the client or a network issue.
uint32 optional_limit = 6 [(.validate.rules) = { ... }
- Specified by:
getOptionalLimit
in interfaceLookupResourcesRequestOrBuilder
- Returns:
- The optionalLimit.
-
setOptionalLimit
optional_limit, if non-zero, specifies the limit on the number of resources to return before the stream is closed on the server side. By default, the stream will continue resolving resources until exhausted or the stream is closed due to the client or a network issue.
uint32 optional_limit = 6 [(.validate.rules) = { ... }
- Parameters:
value
- The optionalLimit to set.- Returns:
- This builder for chaining.
-
clearOptionalLimit
optional_limit, if non-zero, specifies the limit on the number of resources to return before the stream is closed on the server side. By default, the stream will continue resolving resources until exhausted or the stream is closed due to the client or a network issue.
uint32 optional_limit = 6 [(.validate.rules) = { ... }
- Returns:
- This builder for chaining.
-
hasOptionalCursor
public boolean hasOptionalCursor()optional_cursor, if specified, indicates the cursor after which results should resume being returned. The cursor can be found on the LookupResourcesResponse object.
.authzed.api.v1.Cursor optional_cursor = 7;
- Specified by:
hasOptionalCursor
in interfaceLookupResourcesRequestOrBuilder
- Returns:
- Whether the optionalCursor field is set.
-
getOptionalCursor
optional_cursor, if specified, indicates the cursor after which results should resume being returned. The cursor can be found on the LookupResourcesResponse object.
.authzed.api.v1.Cursor optional_cursor = 7;
- Specified by:
getOptionalCursor
in interfaceLookupResourcesRequestOrBuilder
- Returns:
- The optionalCursor.
-
setOptionalCursor
optional_cursor, if specified, indicates the cursor after which results should resume being returned. The cursor can be found on the LookupResourcesResponse object.
.authzed.api.v1.Cursor optional_cursor = 7;
-
setOptionalCursor
optional_cursor, if specified, indicates the cursor after which results should resume being returned. The cursor can be found on the LookupResourcesResponse object.
.authzed.api.v1.Cursor optional_cursor = 7;
-
mergeOptionalCursor
optional_cursor, if specified, indicates the cursor after which results should resume being returned. The cursor can be found on the LookupResourcesResponse object.
.authzed.api.v1.Cursor optional_cursor = 7;
-
clearOptionalCursor
optional_cursor, if specified, indicates the cursor after which results should resume being returned. The cursor can be found on the LookupResourcesResponse object.
.authzed.api.v1.Cursor optional_cursor = 7;
-
getOptionalCursorBuilder
optional_cursor, if specified, indicates the cursor after which results should resume being returned. The cursor can be found on the LookupResourcesResponse object.
.authzed.api.v1.Cursor optional_cursor = 7;
-
getOptionalCursorOrBuilder
optional_cursor, if specified, indicates the cursor after which results should resume being returned. The cursor can be found on the LookupResourcesResponse object.
.authzed.api.v1.Cursor optional_cursor = 7;
- Specified by:
getOptionalCursorOrBuilder
in interfaceLookupResourcesRequestOrBuilder
-