jsonapi

package
v0.0.0-...-4722edd Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 5, 2024 License: BSD-2-Clause Imports: 8 Imported by: 9

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_dictybase_api_jsonapi_payload_proto protoreflect.FileDescriptor
View Source 
var File_dictybase_api_jsonapi_request_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Data 

type Data struct {

	// The resource name.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Unique id.
	Id int64 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

A [resource identifier object](http://jsonapi.org/format/#document-resource-identifier-objects).

func (*Data) Descriptor deprecated 

func (*Data) Descriptor() ([]byte, []int)

Deprecated: Use Data.ProtoReflect.Descriptor instead.

func (*Data) GetId 

func (x *Data) GetId() int64

func (*Data) GetType 

func (x *Data) GetType() string

func (*Data) ProtoMessage 

func (*Data) ProtoMessage()

func (*Data) ProtoReflect 

func (x *Data) ProtoReflect() protoreflect.Message

func (*Data) Reset 

func (x *Data) Reset()

func (*Data) String 

func (x *Data) String() string

func (*Data) Validate 

func (this *Data) Validate() error

type DataCollection 

type DataCollection struct {
	Id   int64   `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
	Data []*Data `protobuf:"bytes,1,rep,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Definition for resource identifier collection objects.

func (*DataCollection) Descriptor deprecated 

func (*DataCollection) Descriptor() ([]byte, []int)

Deprecated: Use DataCollection.ProtoReflect.Descriptor instead.

func (*DataCollection) GetData 

func (x *DataCollection) GetData() []*Data

func (*DataCollection) GetId 

func (x *DataCollection) GetId() int64

func (*DataCollection) ProtoMessage 

func (*DataCollection) ProtoMessage()

func (*DataCollection) ProtoReflect 

func (x *DataCollection) ProtoReflect() protoreflect.Message

func (*DataCollection) Reset 

func (x *DataCollection) Reset()

func (*DataCollection) String 

func (x *DataCollection) String() string

func (*DataCollection) Validate 

func (this *DataCollection) Validate() error

type DeleteRequest 

type DeleteRequest struct {

	// An unique identifier, for example:
	// "/users/34"
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

A `DeleteRequest` defines the url parameter that must be passed to remove a singular resource.

func (*DeleteRequest) Descriptor deprecated 

func (*DeleteRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteRequest.ProtoReflect.Descriptor instead.

func (*DeleteRequest) GetId 

func (x *DeleteRequest) GetId() int64

func (*DeleteRequest) ProtoMessage 

func (*DeleteRequest) ProtoMessage()

func (*DeleteRequest) ProtoReflect 

func (x *DeleteRequest) ProtoReflect() protoreflect.Message

func (*DeleteRequest) Reset 

func (x *DeleteRequest) Reset()

func (*DeleteRequest) String 

func (x *DeleteRequest) String() string

func (*DeleteRequest) Validate 

func (this *DeleteRequest) Validate() error

type ExistResponse 

type ExistResponse struct {

	// exist or non-existant
	Exist bool `protobuf:"varint,1,opt,name=exist,proto3" json:"exist,omitempty"`
	// contains filtered or unexported fields
}

ExistResponse wraps a boolean response

func (*ExistResponse) Descriptor deprecated 

func (*ExistResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExistResponse.ProtoReflect.Descriptor instead.

func (*ExistResponse) GetExist 

func (x *ExistResponse) GetExist() bool

func (*ExistResponse) ProtoMessage 

func (*ExistResponse) ProtoMessage()

func (*ExistResponse) ProtoReflect 

func (x *ExistResponse) ProtoReflect() protoreflect.Message

func (*ExistResponse) Reset 

func (x *ExistResponse) Reset()

func (*ExistResponse) String 

func (x *ExistResponse) String() string

func (*ExistResponse) Validate 

func (this *ExistResponse) Validate() error

type GetEmailRequest 

type GetEmailRequest struct {

	// Email id
	// "/users/newman@seinfeld.org"
	Email string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty"`
	// include query parameter to retrieve any particular or particular
	// combination of relationships. Multiple include values are delimited by
	// comma(,).
	//
	// For example,
	//
	//	/{resource_name}/13?include=baz
	//	/{resource_name}/13?include=baz,bot
	Include string `protobuf:"bytes,2,opt,name=include,proto3" json:"include,omitempty"`
	// fields query parameter to retrieve any particular or any particular
	// combination of attributes. Multiple fields values are delimited by comma(,).
	//
	// For example,
	//
	//	/{resource_name}/29?fields=foo
	//	/{resource_name}/?fields=foo,bar
	Fields string `protobuf:"bytes,3,opt,name=fields,proto3" json:"fields,omitempty"`
	// contains filtered or unexported fields
}

A `GetEmailRequest` is identical to GetRequest except `email` id used as unique identifier.

func (*GetEmailRequest) Descriptor deprecated 

func (*GetEmailRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetEmailRequest.ProtoReflect.Descriptor instead.

func (*GetEmailRequest) GetEmail 

func (x *GetEmailRequest) GetEmail() string

func (*GetEmailRequest) GetFields 

func (x *GetEmailRequest) GetFields() string

func (*GetEmailRequest) GetInclude 

func (x *GetEmailRequest) GetInclude() string

func (*GetEmailRequest) ProtoMessage 

func (*GetEmailRequest) ProtoMessage()

func (*GetEmailRequest) ProtoReflect 

func (x *GetEmailRequest) ProtoReflect() protoreflect.Message

func (*GetEmailRequest) Reset 

func (x *GetEmailRequest) Reset()

func (*GetEmailRequest) String 

func (x *GetEmailRequest) String() string

func (*GetEmailRequest) Validate 

func (this *GetEmailRequest) Validate() error

type GetRequest 

type GetRequest struct {

	// An unique identifier, for example:
	// "/users/34"
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// include query parameter to retrieve any particular or particular
	// combination of relationships. Multiple include values are delimited by
	// comma(,).
	//
	// For example,
	//
	//	/{resource_name}/13?include=baz
	//	/{resource_name}/13?include=baz,bot
	Include string `protobuf:"bytes,2,opt,name=include,proto3" json:"include,omitempty"`
	// fields query parameter to retrieve any particular or any particular
	// combination of attributes. Multiple fields values are delimited by comma(,).
	//
	// For example
	//
	//	/{resource_name}/29?fields=foo
	//	/{resource_name}/?fields=foo,bar
	Fields string `protobuf:"bytes,3,opt,name=fields,proto3" json:"fields,omitempty"`
	// contains filtered or unexported fields
}

A `GetRequest` defines various url and query parameters that could be passed in a HTTP **GET** request to a singular resource. Majority of the request parameters are identical or similar to jsonapi(http://jsonapi.org).

func (*GetRequest) Descriptor deprecated 

func (*GetRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetRequest.ProtoReflect.Descriptor instead.

func (*GetRequest) GetFields 

func (x *GetRequest) GetFields() string

func (*GetRequest) GetId 

func (x *GetRequest) GetId() int64

func (*GetRequest) GetInclude 

func (x *GetRequest) GetInclude() string

func (*GetRequest) ProtoMessage 

func (*GetRequest) ProtoMessage()

func (*GetRequest) ProtoReflect 

func (x *GetRequest) ProtoReflect() protoreflect.Message

func (*GetRequest) Reset 

func (x *GetRequest) Reset()

func (*GetRequest) String 

func (x *GetRequest) String() string

func (*GetRequest) Validate 

func (this *GetRequest) Validate() error

type GetRequestWithFields 

type GetRequestWithFields struct {

	// An unique identifier, for example:
	// "/users/34"
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// fields query parameter to retrieve any particular or any particular
	// combination of attributes. Multiple fields values are delimited by comma(,).
	//
	// For example
	// /{resource_name}/29?fields=foo
	// /{resource_name}/?fields=foo,bar
	Fields string `protobuf:"bytes,2,opt,name=fields,proto3" json:"fields,omitempty"`
	// contains filtered or unexported fields
}

A `GetRequestWithFields` is a subset of GetRequest which only allow the fields parameter.

func (*GetRequestWithFields) Descriptor deprecated 

func (*GetRequestWithFields) Descriptor() ([]byte, []int)

Deprecated: Use GetRequestWithFields.ProtoReflect.Descriptor instead.

func (*GetRequestWithFields) GetFields 

func (x *GetRequestWithFields) GetFields() string

func (*GetRequestWithFields) GetId 

func (x *GetRequestWithFields) GetId() int64

func (*GetRequestWithFields) ProtoMessage 

func (*GetRequestWithFields) ProtoMessage()

func (*GetRequestWithFields) ProtoReflect 

func (x *GetRequestWithFields) ProtoReflect() protoreflect.Message

func (*GetRequestWithFields) Reset 

func (x *GetRequestWithFields) Reset()

func (*GetRequestWithFields) String 

func (x *GetRequestWithFields) String() string

func (*GetRequestWithFields) Validate 

func (this *GetRequestWithFields) Validate() error

type HealthzIdRequest 

type HealthzIdRequest struct {
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*HealthzIdRequest) Descriptor deprecated 

func (*HealthzIdRequest) Descriptor() ([]byte, []int)

Deprecated: Use HealthzIdRequest.ProtoReflect.Descriptor instead.

func (*HealthzIdRequest) GetId 

func (x *HealthzIdRequest) GetId() int64

func (*HealthzIdRequest) ProtoMessage 

func (*HealthzIdRequest) ProtoMessage()

func (*HealthzIdRequest) ProtoReflect 

func (x *HealthzIdRequest) ProtoReflect() protoreflect.Message

func (*HealthzIdRequest) Reset 

func (x *HealthzIdRequest) Reset()

func (*HealthzIdRequest) String 

func (x *HealthzIdRequest) String() string

func (*HealthzIdRequest) Validate 

func (this *HealthzIdRequest) Validate() error

type IdRequest 

type IdRequest struct {

	// An unique identifier
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*IdRequest) Descriptor deprecated 

func (*IdRequest) Descriptor() ([]byte, []int)

Deprecated: Use IdRequest.ProtoReflect.Descriptor instead.

func (*IdRequest) GetId 

func (x *IdRequest) GetId() int64

func (*IdRequest) ProtoMessage 

func (*IdRequest) ProtoMessage()

func (*IdRequest) ProtoReflect 

func (x *IdRequest) ProtoReflect() protoreflect.Message

func (*IdRequest) Reset 

func (x *IdRequest) Reset()

func (*IdRequest) String 

func (x *IdRequest) String() string

func (*IdRequest) Validate 

func (this *IdRequest) Validate() error

type IdResponse 

type IdResponse struct {

	// An unique identifier
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*IdResponse) Descriptor deprecated 

func (*IdResponse) Descriptor() ([]byte, []int)

Deprecated: Use IdResponse.ProtoReflect.Descriptor instead.

func (*IdResponse) GetId 

func (x *IdResponse) GetId() int64

func (*IdResponse) ProtoMessage 

func (*IdResponse) ProtoMessage()

func (*IdResponse) ProtoReflect 

func (x *IdResponse) ProtoReflect() protoreflect.Message

func (*IdResponse) Reset 

func (x *IdResponse) Reset()

func (*IdResponse) String 

func (x *IdResponse) String() string

func (*IdResponse) Validate 

func (this *IdResponse) Validate() error
type Links struct {

	// A http link. It points to the resource itself.
	Self string `protobuf:"bytes,1,opt,name=self,proto3" json:"self,omitempty"`
	// A http link. It points to a related resource.
	Related string `protobuf:"bytes,2,opt,name=related,proto3" json:"related,omitempty"`
	// contains filtered or unexported fields
}

A container for http links.

func (*Links) Descriptor deprecated 

func (*Links) Descriptor() ([]byte, []int)

Deprecated: Use Links.ProtoReflect.Descriptor instead.

func (*Links) GetRelated 

func (x *Links) GetRelated() string

func (*Links) GetSelf 

func (x *Links) GetSelf() string

func (*Links) ProtoMessage 

func (*Links) ProtoMessage()

func (*Links) ProtoReflect 

func (x *Links) ProtoReflect() protoreflect.Message

func (*Links) Reset 

func (x *Links) Reset()

func (*Links) String 

func (x *Links) String() string

func (*Links) Validate 

func (this *Links) Validate() error

type ListRequest 

type ListRequest struct {

	// include query parameter to retrieve any particular or particular
	// combination of relationships. Multiple include values are delimited by
	// comma(,).
	//
	// For example,
	// /{resource_name}/13?include=baz
	// /{resource_name}/13?include=baz,bot
	Include string `protobuf:"bytes,1,opt,name=include,proto3" json:"include,omitempty"`
	// fields query parameter to retrieve any particular or any particular
	// combination of attributes. Multiple fields values are delimited by comma(,).
	//
	// For example
	// /{resource_name}/29?fields=foo
	// /{resource_name}/?fields=foo,bar
	Fields string `protobuf:"bytes,3,opt,name=fields,proto3" json:"fields,omitempty"`
	// The page number to fetch
	Pagenum int64 `protobuf:"varint,4,opt,name=pagenum,proto3" json:"pagenum,omitempty"`
	// Number of records per page
	Pagesize int64 `protobuf:"varint,5,opt,name=pagesize,proto3" json:"pagesize,omitempty"`
	// The `filter` query parameter restricts the data return by the
	// collection. To use it, supply an attribute to filter, followed by a
	// filter expression. It uses the following syntax...
	//
	//	attribute operator expression
	//
	// attribute - Any one of the valid attribute of the resource.
	// operator - Defines the type of filter match to use. It could be any of
	// the following four and all of them should be URL-encoded.
	//
	//	==  Equals (URL encoding is %3D%3D)
	//	!=  Not equals
	//	=@  Contains substring
	//	!@  Not contains substring
	//
	// expression - The value that will be included or excluded from the
	// result. URL-reserved characters must be URL-encoded.
	// For example, the following filter returns all users with last name `Gag`.
	//
	//	/users?filter=last_name%3D%3Dgag
	//
	// Filter can be combined using OR or AND boolean logic.
	//   - The OR is represented using a comma(,).
	//   - The AND is represented using a semi-colon(;).
	//   - AND and OR operators can be combined and AND takes precedence over OR.
	Filter string `protobuf:"bytes,6,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

A `ListRequest` defines various url and query parameters that could be passed in a HTTP **GET** request to a collection resource. All collection resources are expected to support pagination. Majority of the request parameters are identical or similar to jsonapi(http://jsonapi.org).

func (*ListRequest) Descriptor deprecated 

func (*ListRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListRequest.ProtoReflect.Descriptor instead.

func (*ListRequest) GetFields 

func (x *ListRequest) GetFields() string

func (*ListRequest) GetFilter 

func (x *ListRequest) GetFilter() string

func (*ListRequest) GetInclude 

func (x *ListRequest) GetInclude() string

func (*ListRequest) GetPagenum 

func (x *ListRequest) GetPagenum() int64

func (*ListRequest) GetPagesize 

func (x *ListRequest) GetPagesize() int64

func (*ListRequest) ProtoMessage 

func (*ListRequest) ProtoMessage()

func (*ListRequest) ProtoReflect 

func (x *ListRequest) ProtoReflect() protoreflect.Message

func (*ListRequest) Reset 

func (x *ListRequest) Reset()

func (*ListRequest) String 

func (x *ListRequest) String() string

func (*ListRequest) Validate 

func (this *ListRequest) Validate() error

type Meta 

type Meta struct {
	Pagination *Pagination `protobuf:"bytes,1,opt,name=pagination,proto3" json:"pagination,omitempty"`
	// contains filtered or unexported fields
}

Top level meta container.

func (*Meta) Descriptor deprecated 

func (*Meta) Descriptor() ([]byte, []int)

Deprecated: Use Meta.ProtoReflect.Descriptor instead.

func (*Meta) GetPagination 

func (x *Meta) GetPagination() *Pagination

func (*Meta) ProtoMessage 

func (*Meta) ProtoMessage()

func (*Meta) ProtoReflect 

func (x *Meta) ProtoReflect() protoreflect.Message

func (*Meta) Reset 

func (x *Meta) Reset()

func (*Meta) String 

func (x *Meta) String() string

func (*Meta) Validate 

func (this *Meta) Validate() error

type Pagination 

type Pagination struct {

	// Total number of entries, regardless of pages.
	Records int64 `protobuf:"varint,1,opt,name=records,proto3" json:"records,omitempty"`
	// Total number of pages.
	Total int64 `protobuf:"varint,2,opt,name=total,proto3" json:"total,omitempty"`
	// Number of entries per page.
	Size int64 `protobuf:"varint,3,opt,name=size,proto3" json:"size,omitempty"`
	// Current page number.
	Number int64 `protobuf:"varint,4,opt,name=number,proto3" json:"number,omitempty"`
	// contains filtered or unexported fields
}

A container for various pagination properties

func (*Pagination) Descriptor deprecated 

func (*Pagination) Descriptor() ([]byte, []int)

Deprecated: Use Pagination.ProtoReflect.Descriptor instead.

func (*Pagination) GetNumber 

func (x *Pagination) GetNumber() int64

func (*Pagination) GetRecords 

func (x *Pagination) GetRecords() int64

func (*Pagination) GetSize 

func (x *Pagination) GetSize() int64

func (*Pagination) GetTotal 

func (x *Pagination) GetTotal() int64

func (*Pagination) ProtoMessage 

func (*Pagination) ProtoMessage()

func (*Pagination) ProtoReflect 

func (x *Pagination) ProtoReflect() protoreflect.Message

func (*Pagination) Reset 

func (x *Pagination) Reset()

func (*Pagination) String 

func (x *Pagination) String() string

func (*Pagination) Validate 

func (this *Pagination) Validate() error
type PaginationLinks struct {

	// A http link to the resource itself.
	Self string `protobuf:"bytes,1,opt,name=self,proto3" json:"self,omitempty"`
	// A http link to the next page of data.
	Next string `protobuf:"bytes,2,opt,name=next,proto3" json:"next,omitempty"`
	// A http link to the previous page of data.
	Prev string `protobuf:"bytes,3,opt,name=prev,proto3" json:"prev,omitempty"`
	// A http link to the last page of data.
	Last string `protobuf:"bytes,4,opt,name=last,proto3" json:"last,omitempty"`
	// A http link to the first page of data.
	First string `protobuf:"bytes,5,opt,name=first,proto3" json:"first,omitempty"`
	// contains filtered or unexported fields
}

A container for pagination links.

func (*PaginationLinks) Descriptor deprecated 

func (*PaginationLinks) Descriptor() ([]byte, []int)

Deprecated: Use PaginationLinks.ProtoReflect.Descriptor instead.

func (*PaginationLinks) GetFirst 

func (x *PaginationLinks) GetFirst() string

func (*PaginationLinks) GetLast 

func (x *PaginationLinks) GetLast() string

func (*PaginationLinks) GetNext 

func (x *PaginationLinks) GetNext() string

func (*PaginationLinks) GetPrev 

func (x *PaginationLinks) GetPrev() string

func (*PaginationLinks) GetSelf 

func (x *PaginationLinks) GetSelf() string

func (*PaginationLinks) ProtoMessage 

func (*PaginationLinks) ProtoMessage()

func (*PaginationLinks) ProtoReflect 

func (x *PaginationLinks) ProtoReflect() protoreflect.Message

func (*PaginationLinks) Reset 

func (x *PaginationLinks) Reset()

func (*PaginationLinks) String 

func (x *PaginationLinks) String() string

func (*PaginationLinks) Validate 

func (this *PaginationLinks) Validate() error

type RelationshipRequest 

type RelationshipRequest struct {

	// An unique identifier, for example:
	// "/users/45/roles" or "/users/45/relationships/roles"
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

A `RelationshipRequest` defines the url parameter for relationship resources that are given in the links field of relationship object

func (*RelationshipRequest) Descriptor deprecated 

func (*RelationshipRequest) Descriptor() ([]byte, []int)

Deprecated: Use RelationshipRequest.ProtoReflect.Descriptor instead.

func (*RelationshipRequest) GetId 

func (x *RelationshipRequest) GetId() int64

func (*RelationshipRequest) ProtoMessage 

func (*RelationshipRequest) ProtoMessage()

func (*RelationshipRequest) ProtoReflect 

func (x *RelationshipRequest) ProtoReflect() protoreflect.Message

func (*RelationshipRequest) Reset 

func (x *RelationshipRequest) Reset()

func (*RelationshipRequest) String 

func (x *RelationshipRequest) String() string

func (*RelationshipRequest) Validate 

func (this *RelationshipRequest) Validate() error

type RelationshipRequestWithPagination 

type RelationshipRequestWithPagination struct {
	Id       int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Pagenum  int64 `protobuf:"varint,4,opt,name=pagenum,proto3" json:"pagenum,omitempty"`
	Pagesize int64 `protobuf:"varint,3,opt,name=pagesize,proto3" json:"pagesize,omitempty"`
	// contains filtered or unexported fields
}

A `RelationshipRequestWithPagination` is a `RelationshipRequest` with pagination

func (*RelationshipRequestWithPagination) Descriptor deprecated 

func (*RelationshipRequestWithPagination) Descriptor() ([]byte, []int)

Deprecated: Use RelationshipRequestWithPagination.ProtoReflect.Descriptor instead.

func (*RelationshipRequestWithPagination) GetId 

func (x *RelationshipRequestWithPagination) GetId() int64

func (*RelationshipRequestWithPagination) GetPagenum 

func (x *RelationshipRequestWithPagination) GetPagenum() int64

func (*RelationshipRequestWithPagination) GetPagesize 

func (x *RelationshipRequestWithPagination) GetPagesize() int64

func (*RelationshipRequestWithPagination) ProtoMessage 

func (*RelationshipRequestWithPagination) ProtoMessage()

func (*RelationshipRequestWithPagination) ProtoReflect 

func (x *RelationshipRequestWithPagination) ProtoReflect() protoreflect.Message

func (*RelationshipRequestWithPagination) Reset 

func (x *RelationshipRequestWithPagination) Reset()

func (*RelationshipRequestWithPagination) String 

func (x *RelationshipRequestWithPagination) String() string

func (*RelationshipRequestWithPagination) Validate 

func (this *RelationshipRequestWithPagination) Validate() error

type SimpleListRequest 

type SimpleListRequest struct {

	// include query parameter to retrieve any particular or particular
	// combination of relationships. Multiple include values are delimited by
	// comma(,).
	//
	// For example,
	// /{resource_name}/13?include=baz
	// /{resource_name}/13?include=baz,bot
	Include string `protobuf:"bytes,1,opt,name=include,proto3" json:"include,omitempty"`
	// fields query parameter to retrieve any particular or any particular
	// combination of attributes. Multiple fields values are delimited by comma(,).
	//
	// For example
	// /{resource_name}/29?fields=foo
	// /{resource_name}/?fields=foo,bar
	Fields string `protobuf:"bytes,2,opt,name=fields,proto3" json:"fields,omitempty"`
	// The `filter` query parameter restricts the data return by the
	// collection. To use it, supply an attribute to filter, followed by a
	// filter expression. It uses the following syntax...
	//
	//	attribute operator expression
	//
	// attribute - Any one of the valid attribute of the resource.
	// operator - Defines the type of filter match to use. It could be any of
	// the following four and all of them should be URL-encoded.
	//
	//	==  Equals (URL encoding is %3D%3D)
	//	!=  Not equals
	//	=@  Contains substring
	//	!@  Not contains substring
	//
	// expression - The value that will be included or excluded from the
	// result. URL-reserved characters must be URL-encoded.
	// For example, the following filter returns all users with last name `Gag`.
	//
	//	/users?filter=last_name%3D%3Dgag
	//
	// Filter can be combined using OR or AND boolean logic.
	//   - The OR is represented using a comma(,).
	//   - The AND is represented using a semi-colon(;).
	//   - AND and OR operators can be combined and AND takes precedence over OR.
	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

A `SimpleListRequest` is identical to `ListRequest` except it does not support pagination. The rest of the parameters are identical to `ListRequest` definition.

func (*SimpleListRequest) Descriptor deprecated 

func (*SimpleListRequest) Descriptor() ([]byte, []int)

Deprecated: Use SimpleListRequest.ProtoReflect.Descriptor instead.

func (*SimpleListRequest) GetFields 

func (x *SimpleListRequest) GetFields() string

func (*SimpleListRequest) GetFilter 

func (x *SimpleListRequest) GetFilter() string

func (*SimpleListRequest) GetInclude 

func (x *SimpleListRequest) GetInclude() string

func (*SimpleListRequest) ProtoMessage 

func (*SimpleListRequest) ProtoMessage()

func (*SimpleListRequest) ProtoReflect 

func (x *SimpleListRequest) ProtoReflect() protoreflect.Message

func (*SimpleListRequest) Reset 

func (x *SimpleListRequest) Reset()

func (*SimpleListRequest) String 

func (x *SimpleListRequest) String() string

func (*SimpleListRequest) Validate 

func (this *SimpleListRequest) Validate() error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.