pbresource

package
v0.16.4 Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Condition_State_name = map[int32]string{
		0: "STATE_UNKNOWN",
		1: "STATE_TRUE",
		2: "STATE_FALSE",
	}
	Condition_State_value = map[string]int32{
		"STATE_UNKNOWN": 0,
		"STATE_TRUE":    1,
		"STATE_FALSE":   2,
	}
)

Enum value maps for Condition_State.

View Source 
var (
	WatchEvent_Operation_name = map[int32]string{
		0: "OPERATION_UNSPECIFIED",
		1: "OPERATION_UPSERT",
		2: "OPERATION_DELETE",
	}
	WatchEvent_Operation_value = map[string]int32{
		"OPERATION_UNSPECIFIED": 0,
		"OPERATION_UPSERT":      1,
		"OPERATION_DELETE":      2,
	}
)

Enum value maps for WatchEvent_Operation.

View Source 
var File_pbresource_resource_proto protoreflect.FileDescriptor
View Source 
var ResourceService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "hashicorp.consul.resource.ResourceService",
	HandlerType: (*ResourceServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Read",
			Handler:    _ResourceService_Read_Handler,
		},
		{
			MethodName: "Write",
			Handler:    _ResourceService_Write_Handler,
		},
		{
			MethodName: "WriteStatus",
			Handler:    _ResourceService_WriteStatus_Handler,
		},
		{
			MethodName: "List",
			Handler:    _ResourceService_List_Handler,
		},
		{
			MethodName: "ListByOwner",
			Handler:    _ResourceService_ListByOwner_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _ResourceService_Delete_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "WatchList",
			Handler:       _ResourceService_WatchList_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "pbresource/resource.proto",
}

ResourceService_ServiceDesc is the grpc.ServiceDesc for ResourceService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterResourceServiceServer 

func RegisterResourceServiceServer(s grpc.ServiceRegistrar, srv ResourceServiceServer)

Types

type Condition 

type Condition struct {

	// Type identifies the type of condition (e.g. "Invalid", "ResolvedRefs").
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// State represents the state of the condition (i.e. true/false/unknown).
	State Condition_State `protobuf:"varint,2,opt,name=state,proto3,enum=hashicorp.consul.resource.Condition_State" json:"state,omitempty"`
	// Reason provides more machine-readable details about the condition (e.g.
	// "InvalidProtocol").
	Reason string `protobuf:"bytes,3,opt,name=reason,proto3" json:"reason,omitempty"`
	// Message contains a human-friendly description of the status.
	Message string `protobuf:"bytes,4,opt,name=message,proto3" json:"message,omitempty"`
	// Resource identifies which resource this condition relates to, when it is
	// not the core resource itself.
	Resource *Reference `protobuf:"bytes,5,opt,name=resource,proto3" json:"resource,omitempty"`
	// contains filtered or unexported fields
}

Condition represents a discreet observation about a resource in relation to the current state of the system.

It is heavily inspired by Kubernetes' [conditions](https://bit.ly/3H9Y6IK) and the Gateway API [types and reasons](https://bit.ly/3n2PPiP).

func (*Condition) Descriptor deprecated 

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

Deprecated: Use Condition.ProtoReflect.Descriptor instead.

func (*Condition) GetMessage 

func (x *Condition) GetMessage() string

func (*Condition) GetReason 

func (x *Condition) GetReason() string

func (*Condition) GetResource 

func (x *Condition) GetResource() *Reference

func (*Condition) GetState 

func (x *Condition) GetState() Condition_State

func (*Condition) GetType 

func (x *Condition) GetType() string

func (*Condition) MarshalBinary 

func (msg *Condition) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*Condition) ProtoMessage 

func (*Condition) ProtoMessage()

func (*Condition) ProtoReflect 

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

func (*Condition) Reset 

func (x *Condition) Reset()

func (*Condition) String 

func (x *Condition) String() string

func (*Condition) UnmarshalBinary 

func (msg *Condition) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type Condition_State 

type Condition_State int32

State represents the state of the condition (i.e. true/false/unknown). 

const (
	// STATE_UNKNOWN means that the state of the condition is unknown.
	//
	// buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
	Condition_STATE_UNKNOWN Condition_State = 0
	// STATE_TRUE means that the state of the condition is true.
	Condition_STATE_TRUE Condition_State = 1
	// STATE_FALSE means that the state of the condition is false.
	Condition_STATE_FALSE Condition_State = 2
)

func (Condition_State) Descriptor 

func (Condition_State) Descriptor() protoreflect.EnumDescriptor

func (Condition_State) Enum 

func (x Condition_State) Enum() *Condition_State

func (Condition_State) EnumDescriptor deprecated 

func (Condition_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Condition_State.Descriptor instead.

func (Condition_State) Number 

func (x Condition_State) Number() protoreflect.EnumNumber

func (Condition_State) String 

func (x Condition_State) String() string

func (Condition_State) Type 

func (Condition_State) Type() protoreflect.EnumType

type DeleteRequest 

type DeleteRequest struct {

	// ID of the resource that will be deleted.
	Id *ID `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Version may be provided to perform a CAS (Compare-And-Swap) deletion of the
	// resource. If the given version doesn't match what is currently stored, an
	// Aborted error code will be returned.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

DeleteRequest contains the parameters to the Delete endpoint.

func (*DeleteRequest) Descriptor deprecated 

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

Deprecated: Use DeleteRequest.ProtoReflect.Descriptor instead.

func (*DeleteRequest) GetId 

func (x *DeleteRequest) GetId() *ID

func (*DeleteRequest) GetVersion 

func (x *DeleteRequest) GetVersion() string

func (*DeleteRequest) MarshalBinary 

func (msg *DeleteRequest) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

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) UnmarshalBinary 

func (msg *DeleteRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type DeleteResponse 

type DeleteResponse struct {
	// contains filtered or unexported fields
}

DeleteResponse contains the results of calling the Delete endpoint.

func (*DeleteResponse) Descriptor deprecated 

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

Deprecated: Use DeleteResponse.ProtoReflect.Descriptor instead.

func (*DeleteResponse) MarshalBinary 

func (msg *DeleteResponse) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*DeleteResponse) ProtoMessage 

func (*DeleteResponse) ProtoMessage()

func (*DeleteResponse) ProtoReflect 

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

func (*DeleteResponse) Reset 

func (x *DeleteResponse) Reset()

func (*DeleteResponse) String 

func (x *DeleteResponse) String() string

func (*DeleteResponse) UnmarshalBinary 

func (msg *DeleteResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type ID 

type ID struct {

	// Uid is the unique internal identifier we gave to the resource.
	//
	// It is primarily used to tell the difference between the current resource
	// and previous deleted resources with the same user-given name.
	//
	// Concretely, Uid is a [ULID](https://github.com/ulid/spec) and you can treat
	// its timestamp component as the resource's creation time.
	Uid string `protobuf:"bytes,1,opt,name=uid,proto3" json:"uid,omitempty"`
	// Name is the user-given name of the resource (e.g. the "billing" service).
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Type identifies the resource's type.
	Type *Type `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	// Tenancy identifies the tenancy units (i.e. partition, namespace) in which
	// the resource resides.
	Tenancy *Tenancy `protobuf:"bytes,4,opt,name=tenancy,proto3" json:"tenancy,omitempty"`
	// contains filtered or unexported fields
}

ID uniquely identifies a resource.

func (*ID) Descriptor deprecated 

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

Deprecated: Use ID.ProtoReflect.Descriptor instead.

func (*ID) GetName 

func (x *ID) GetName() string

func (*ID) GetTenancy 

func (x *ID) GetTenancy() *Tenancy

func (*ID) GetType 

func (x *ID) GetType() *Type

func (*ID) GetUid 

func (x *ID) GetUid() string

func (*ID) MarshalBinary 

func (msg *ID) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*ID) ProtoMessage 

func (*ID) ProtoMessage()

func (*ID) ProtoReflect 

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

func (*ID) Reset 

func (x *ID) Reset()

func (*ID) String 

func (x *ID) String() string

func (*ID) UnmarshalBinary 

func (msg *ID) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type ListByOwnerRequest 

type ListByOwnerRequest struct {
	Owner *ID `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
	// contains filtered or unexported fields
}

ListByOwnerRequest contains the parameters to the ListByOwner endpoint.

func (*ListByOwnerRequest) Descriptor deprecated 

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

Deprecated: Use ListByOwnerRequest.ProtoReflect.Descriptor instead.

func (*ListByOwnerRequest) GetOwner 

func (x *ListByOwnerRequest) GetOwner() *ID

func (*ListByOwnerRequest) MarshalBinary 

func (msg *ListByOwnerRequest) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*ListByOwnerRequest) ProtoMessage 

func (*ListByOwnerRequest) ProtoMessage()

func (*ListByOwnerRequest) ProtoReflect 

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

func (*ListByOwnerRequest) Reset 

func (x *ListByOwnerRequest) Reset()

func (*ListByOwnerRequest) String 

func (x *ListByOwnerRequest) String() string

func (*ListByOwnerRequest) UnmarshalBinary 

func (msg *ListByOwnerRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type ListByOwnerResponse 

type ListByOwnerResponse struct {

	// Resources that were listed.
	Resources []*Resource `protobuf:"bytes,1,rep,name=resources,proto3" json:"resources,omitempty"`
	// contains filtered or unexported fields
}

ListByOwnerResponse contains the results of calling the ListByOwner endpoint.

func (*ListByOwnerResponse) Descriptor deprecated 

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

Deprecated: Use ListByOwnerResponse.ProtoReflect.Descriptor instead.

func (*ListByOwnerResponse) GetResources 

func (x *ListByOwnerResponse) GetResources() []*Resource

func (*ListByOwnerResponse) MarshalBinary 

func (msg *ListByOwnerResponse) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*ListByOwnerResponse) ProtoMessage 

func (*ListByOwnerResponse) ProtoMessage()

func (*ListByOwnerResponse) ProtoReflect 

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

func (*ListByOwnerResponse) Reset 

func (x *ListByOwnerResponse) Reset()

func (*ListByOwnerResponse) String 

func (x *ListByOwnerResponse) String() string

func (*ListByOwnerResponse) UnmarshalBinary 

func (msg *ListByOwnerResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type ListRequest 

type ListRequest struct {

	// Type of resource to list.
	Type *Type `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Tenancy units in which to list resources. To list resources in all units,
	// provide the wildcard "*" value.
	Tenancy *Tenancy `protobuf:"bytes,2,opt,name=tenancy,proto3" json:"tenancy,omitempty"`
	// NamePrefix filters the results to those with a name beginning with the
	// given prefix.
	NamePrefix string `protobuf:"bytes,3,opt,name=name_prefix,json=namePrefix,proto3" json:"name_prefix,omitempty"`
	// contains filtered or unexported fields
}

ListRequest contains the parameters to the List endpoint.

func (*ListRequest) Descriptor deprecated 

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

Deprecated: Use ListRequest.ProtoReflect.Descriptor instead.

func (*ListRequest) GetNamePrefix 

func (x *ListRequest) GetNamePrefix() string

func (*ListRequest) GetTenancy 

func (x *ListRequest) GetTenancy() *Tenancy

func (*ListRequest) GetType 

func (x *ListRequest) GetType() *Type

func (*ListRequest) MarshalBinary 

func (msg *ListRequest) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

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) UnmarshalBinary 

func (msg *ListRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type ListResponse 

type ListResponse struct {

	// Resources that were listed.
	Resources []*Resource `protobuf:"bytes,1,rep,name=resources,proto3" json:"resources,omitempty"`
	// contains filtered or unexported fields
}

ListResponse contains the results of calling the List endpoint.

func (*ListResponse) Descriptor deprecated 

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

Deprecated: Use ListResponse.ProtoReflect.Descriptor instead.

func (*ListResponse) GetResources 

func (x *ListResponse) GetResources() []*Resource

func (*ListResponse) MarshalBinary 

func (msg *ListResponse) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*ListResponse) ProtoMessage 

func (*ListResponse) ProtoMessage()

func (*ListResponse) ProtoReflect 

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

func (*ListResponse) Reset 

func (x *ListResponse) Reset()

func (*ListResponse) String 

func (x *ListResponse) String() string

func (*ListResponse) UnmarshalBinary 

func (msg *ListResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type ReadRequest 

type ReadRequest struct {

	// ID of the resource.
	Id *ID `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

ReadRequest contains the parameters to the Read endpoint.

func (*ReadRequest) Descriptor deprecated 

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

Deprecated: Use ReadRequest.ProtoReflect.Descriptor instead.

func (*ReadRequest) GetId 

func (x *ReadRequest) GetId() *ID

func (*ReadRequest) MarshalBinary 

func (msg *ReadRequest) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*ReadRequest) ProtoMessage 

func (*ReadRequest) ProtoMessage()

func (*ReadRequest) ProtoReflect 

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

func (*ReadRequest) Reset 

func (x *ReadRequest) Reset()

func (*ReadRequest) String 

func (x *ReadRequest) String() string

func (*ReadRequest) UnmarshalBinary 

func (msg *ReadRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type ReadResponse 

type ReadResponse struct {

	// Resource that was read.
	Resource *Resource `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
	// contains filtered or unexported fields
}

ReadResponse contains the results of calling the Read endpoint.

func (*ReadResponse) Descriptor deprecated 

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

Deprecated: Use ReadResponse.ProtoReflect.Descriptor instead.

func (*ReadResponse) GetResource 

func (x *ReadResponse) GetResource() *Resource

func (*ReadResponse) MarshalBinary 

func (msg *ReadResponse) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*ReadResponse) ProtoMessage 

func (*ReadResponse) ProtoMessage()

func (*ReadResponse) ProtoReflect 

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

func (*ReadResponse) Reset 

func (x *ReadResponse) Reset()

func (*ReadResponse) String 

func (x *ReadResponse) String() string

func (*ReadResponse) UnmarshalBinary 

func (msg *ReadResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type Reference 

type Reference struct {

	// Type identifies the resource's type.
	Type *Type `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Tenancy identifies the tenancy units (i.e. partition, namespace) in which
	// the resource resides.
	Tenancy *Tenancy `protobuf:"bytes,2,opt,name=tenancy,proto3" json:"tenancy,omitempty"`
	// Name is the user-given name of the resource (e.g. the "billing" service).
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// Section identifies which part of the resource the condition relates to.
	Section string `protobuf:"bytes,4,opt,name=section,proto3" json:"section,omitempty"`
	// contains filtered or unexported fields
}

Reference identifies which resource a condition relates to, when it is not the core resource itself.

func (*Reference) Descriptor deprecated 

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

Deprecated: Use Reference.ProtoReflect.Descriptor instead.

func (*Reference) GetName 

func (x *Reference) GetName() string

func (*Reference) GetSection 

func (x *Reference) GetSection() string

func (*Reference) GetTenancy 

func (x *Reference) GetTenancy() *Tenancy

func (*Reference) GetType 

func (x *Reference) GetType() *Type

func (*Reference) MarshalBinary 

func (msg *Reference) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*Reference) ProtoMessage 

func (*Reference) ProtoMessage()

func (*Reference) ProtoReflect 

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

func (*Reference) Reset 

func (x *Reference) Reset()

func (*Reference) String 

func (x *Reference) String() string

func (*Reference) UnmarshalBinary 

func (msg *Reference) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type Resource 

type Resource struct {

	// ID uniquely identifies the resource.
	Id *ID `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Owner (optionally) describes which resource "owns" this resource, it is
	// immutable and can only be set on resource creation. Owned resources will
	// be automatically deleted when their owner is deleted.
	Owner *ID `protobuf:"bytes,2,opt,name=owner,proto3" json:"owner,omitempty"`
	// Version is the low-level version identifier used by the storage backend
	// in CAS (Compare-And-Swap) operations. It will change when the resource is
	// modified in any way, including status updates.
	//
	// When calling the Write endpoint, providing a non-blank version will perform
	// a CAS (Compare-And-Swap) write, which will result in an Aborted error code
	// if the given version doesn't match what is stored.
	Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// Generation is incremented whenever the resource's content (i.e. not its
	// status) is modified. You can think of it as being the "user version".
	//
	// Concretely, Generation is a [ULID](https://github.com/ulid/spec) and you
	// can treat its timestamp component as the resource's modification time.
	Generation string `protobuf:"bytes,4,opt,name=generation,proto3" json:"generation,omitempty"`
	// Metadata contains key/value pairs of arbitrary metadata about the resource.
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// Status is used by controllers to communicate the result of attempting to
	// reconcile and apply the resource (e.g. surface semantic validation errors)
	// with users and other controllers. Each status is identified by a unique key
	// and should only ever be updated by one controller.
	//
	// Status can only be updated via the WriteStatus endpoint. Attempting to do
	// so via the Write endpoint will result in an InvalidArgument error code.
	Status map[string]*Status `` /* 153-byte string literal not displayed */
	// Data contains the resource's type-specific content.
	Data *anypb.Any `protobuf:"bytes,7,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Resource describes a resource of a known type managed by Consul.

func (*Resource) Descriptor deprecated 

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

Deprecated: Use Resource.ProtoReflect.Descriptor instead.

func (*Resource) GetData 

func (x *Resource) GetData() *anypb.Any

func (*Resource) GetGeneration 

func (x *Resource) GetGeneration() string

func (*Resource) GetId 

func (x *Resource) GetId() *ID

func (*Resource) GetMetadata 

func (x *Resource) GetMetadata() map[string]string

func (*Resource) GetOwner 

func (x *Resource) GetOwner() *ID

func (*Resource) GetStatus 

func (x *Resource) GetStatus() map[string]*Status

func (*Resource) GetVersion 

func (x *Resource) GetVersion() string

func (*Resource) MarshalBinary 

func (msg *Resource) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*Resource) ProtoMessage 

func (*Resource) ProtoMessage()

func (*Resource) ProtoReflect 

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

func (*Resource) Reset 

func (x *Resource) Reset()

func (*Resource) String 

func (x *Resource) String() string

func (*Resource) UnmarshalBinary 

func (msg *Resource) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type ResourceServiceClient 

type ResourceServiceClient interface {
	// Read a resource by ID.
	//
	// By default, reads are eventually consistent, but you can opt-in to strong
	// consistency via the x-consul-consistency-mode metadata (see ResourceService
	// docs for more info).
	//
	// Errors with NotFound if the resource is not found.
	//
	// Errors with InvalidArgument if the request fails validation or the resource
	// is stored as a type with a different GroupVersion than was requested.
	//
	// Errors with PermissionDenied if the caller is not authorized to read
	// the resource.
	Read(ctx context.Context, in *ReadRequest, opts ...grpc.CallOption) (*ReadResponse, error)
	// Write a resource.
	//
	// To perform a CAS (Compare-And-Swap) write, provide the current resource
	// version in the Resource.Version field. If the given version doesn't match
	// what is currently stored, an Aborted error code will be returned.
	//
	// To perform a blanket write (update regardless of the stored version),
	// provide an empty Version in the Resource.Version field. Note that the
	// write may still fail due to not being able to internally do a CAS write
	// and return an Aborted error code.
	//
	// Resource.Id.Uid can (and by controllers, should) be provided to avoid
	// accidentally modifying a resource if it has been deleted and recreated.
	// If the given Uid doesn't match what is stored, a FailedPrecondition error
	// code will be returned.
	//
	// It is not possible to modify the resource's status using Write. You must
	// use WriteStatus instead.
	Write(ctx context.Context, in *WriteRequest, opts ...grpc.CallOption) (*WriteResponse, error)
	// WriteStatus updates one of the resource's statuses. It should only be used
	// by controllers.
	//
	// To perform a CAS (Compare-And-Swap) write, provide the current resource
	// version in the Version field. If the given version doesn't match what is
	// currently stored, an Aborted error code will be returned.
	//
	// Note: in most cases, CAS status updates are not necessary because updates
	// are scoped to a specific status key and controllers are leader-elected so
	// there is no chance of a conflict.
	//
	// Id.Uid must be provided to avoid accidentally modifying a resource if it has
	// been deleted and recreated. If the given Uid doesn't match what is stored,
	// a FailedPrecondition error code will be returned.
	WriteStatus(ctx context.Context, in *WriteStatusRequest, opts ...grpc.CallOption) (*WriteStatusResponse, error)
	// List resources of a given type, tenancy, and optionally name prefix.
	//
	// To list resources across all tenancy units, provide the wildcard "*" value.
	//
	// Results are eventually consistent (see ResourceService docs for more info).
	List(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*ListResponse, error)
	// List resources of a given owner.
	//
	// Results are eventually consistent (see ResourceService docs for more info).
	ListByOwner(ctx context.Context, in *ListByOwnerRequest, opts ...grpc.CallOption) (*ListByOwnerResponse, error)
	// Delete a resource by ID.
	//
	// Deleting a non-existent resource will return a successful response for
	// idempotency.
	//
	// To perform a CAS (Compare-And-Swap) deletion, provide the current resource
	// version in the Version field. If the given version doesn't match what is
	// currently stored, an Aborted error code will be returned.
	//
	// Resource.Id.Uid can (and by controllers, should) be provided to avoid
	// accidentally modifying a resource if it has been deleted and recreated.
	// If the given Uid doesn't match what is stored, a FailedPrecondition error
	// code will be returned.
	Delete(ctx context.Context, in *DeleteRequest, opts ...grpc.CallOption) (*DeleteResponse, error)
	// WatchList watches resources of the given type, tenancy, and optionally name
	// prefix. It returns results for the current state-of-the-world at the start
	// of the stream, and delta events whenever resources are written or deleted.
	//
	// To watch resources across all tenancy units, provide the wildcard "*" value.
	//
	// WatchList makes no guarantees about event timeliness (e.g. an event for a
	// write may not be received immediately), but it does guarantee that events
	// will be emitted in the correct order. See ResourceService docs for more
	// info about consistency guarentees.
	//
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	WatchList(ctx context.Context, in *WatchListRequest, opts ...grpc.CallOption) (ResourceService_WatchListClient, error)
}

ResourceServiceClient is the client API for ResourceService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewResourceServiceClient 

func NewResourceServiceClient(cc grpc.ClientConnInterface) ResourceServiceClient

type ResourceServiceServer 

type ResourceServiceServer interface {
	// Read a resource by ID.
	//
	// By default, reads are eventually consistent, but you can opt-in to strong
	// consistency via the x-consul-consistency-mode metadata (see ResourceService
	// docs for more info).
	//
	// Errors with NotFound if the resource is not found.
	//
	// Errors with InvalidArgument if the request fails validation or the resource
	// is stored as a type with a different GroupVersion than was requested.
	//
	// Errors with PermissionDenied if the caller is not authorized to read
	// the resource.
	Read(context.Context, *ReadRequest) (*ReadResponse, error)
	// Write a resource.
	//
	// To perform a CAS (Compare-And-Swap) write, provide the current resource
	// version in the Resource.Version field. If the given version doesn't match
	// what is currently stored, an Aborted error code will be returned.
	//
	// To perform a blanket write (update regardless of the stored version),
	// provide an empty Version in the Resource.Version field. Note that the
	// write may still fail due to not being able to internally do a CAS write
	// and return an Aborted error code.
	//
	// Resource.Id.Uid can (and by controllers, should) be provided to avoid
	// accidentally modifying a resource if it has been deleted and recreated.
	// If the given Uid doesn't match what is stored, a FailedPrecondition error
	// code will be returned.
	//
	// It is not possible to modify the resource's status using Write. You must
	// use WriteStatus instead.
	Write(context.Context, *WriteRequest) (*WriteResponse, error)
	// WriteStatus updates one of the resource's statuses. It should only be used
	// by controllers.
	//
	// To perform a CAS (Compare-And-Swap) write, provide the current resource
	// version in the Version field. If the given version doesn't match what is
	// currently stored, an Aborted error code will be returned.
	//
	// Note: in most cases, CAS status updates are not necessary because updates
	// are scoped to a specific status key and controllers are leader-elected so
	// there is no chance of a conflict.
	//
	// Id.Uid must be provided to avoid accidentally modifying a resource if it has
	// been deleted and recreated. If the given Uid doesn't match what is stored,
	// a FailedPrecondition error code will be returned.
	WriteStatus(context.Context, *WriteStatusRequest) (*WriteStatusResponse, error)
	// List resources of a given type, tenancy, and optionally name prefix.
	//
	// To list resources across all tenancy units, provide the wildcard "*" value.
	//
	// Results are eventually consistent (see ResourceService docs for more info).
	List(context.Context, *ListRequest) (*ListResponse, error)
	// List resources of a given owner.
	//
	// Results are eventually consistent (see ResourceService docs for more info).
	ListByOwner(context.Context, *ListByOwnerRequest) (*ListByOwnerResponse, error)
	// Delete a resource by ID.
	//
	// Deleting a non-existent resource will return a successful response for
	// idempotency.
	//
	// To perform a CAS (Compare-And-Swap) deletion, provide the current resource
	// version in the Version field. If the given version doesn't match what is
	// currently stored, an Aborted error code will be returned.
	//
	// Resource.Id.Uid can (and by controllers, should) be provided to avoid
	// accidentally modifying a resource if it has been deleted and recreated.
	// If the given Uid doesn't match what is stored, a FailedPrecondition error
	// code will be returned.
	Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)
	// WatchList watches resources of the given type, tenancy, and optionally name
	// prefix. It returns results for the current state-of-the-world at the start
	// of the stream, and delta events whenever resources are written or deleted.
	//
	// To watch resources across all tenancy units, provide the wildcard "*" value.
	//
	// WatchList makes no guarantees about event timeliness (e.g. an event for a
	// write may not be received immediately), but it does guarantee that events
	// will be emitted in the correct order. See ResourceService docs for more
	// info about consistency guarentees.
	//
	// buf:lint:ignore RPC_RESPONSE_STANDARD_NAME
	WatchList(*WatchListRequest, ResourceService_WatchListServer) error
}

ResourceServiceServer is the server API for ResourceService service. All implementations should embed UnimplementedResourceServiceServer for forward compatibility

type ResourceService_WatchListClient 

type ResourceService_WatchListClient interface {
	Recv() (*WatchEvent, error)
	grpc.ClientStream
}

type ResourceService_WatchListServer 

type ResourceService_WatchListServer interface {
	Send(*WatchEvent) error
	grpc.ServerStream
}

type Status 

type Status struct {

	// ObservedGeneration identifies which generation of a resource this status
	// related to. It can be used to determine whether the current generation of
	// a resource has been reconciled.
	ObservedGeneration string `protobuf:"bytes,1,opt,name=observed_generation,json=observedGeneration,proto3" json:"observed_generation,omitempty"`
	// Conditions contains a set of discreet observations about the resource in
	// relation to the current state of the system (e.g. it is semantically valid).
	Conditions []*Condition `protobuf:"bytes,2,rep,name=conditions,proto3" json:"conditions,omitempty"`
	// UpdatedAt is the time at which the status was last written.
	UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// contains filtered or unexported fields
}

Status is used by controllers to communicate the result of attempting to reconcile and apply a resource (e.g. surface semantic validation errors) with users and other controllers.

func (*Status) Descriptor deprecated 

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

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetConditions 

func (x *Status) GetConditions() []*Condition

func (*Status) GetObservedGeneration 

func (x *Status) GetObservedGeneration() string

func (*Status) GetUpdatedAt 

func (x *Status) GetUpdatedAt() *timestamppb.Timestamp

func (*Status) MarshalBinary 

func (msg *Status) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*Status) ProtoMessage 

func (*Status) ProtoMessage()

func (*Status) ProtoReflect 

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

func (*Status) Reset 

func (x *Status) Reset()

func (*Status) String 

func (x *Status) String() string

func (*Status) UnmarshalBinary 

func (msg *Status) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type Tenancy 

type Tenancy struct {

	// Partition is the topmost administrative boundary within a cluster.
	// https://developer.hashicorp.com/consul/docs/enterprise/admin-partitions
	//
	// When using the List and WatchList endpoints, provide the wildcard value "*"
	// to list resources across all partitions.
	Partition string `protobuf:"bytes,1,opt,name=partition,proto3" json:"partition,omitempty"`
	// Namespace further isolates resources within a partition.
	// https://developer.hashicorp.com/consul/docs/enterprise/namespaces
	//
	// When using the List and WatchList endpoints, provide the wildcard value "*"
	// to list resources across all namespaces.
	Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// PeerName identifies which peer the resource is imported from.
	// https://developer.hashicorp.com/consul/docs/connect/cluster-peering
	//
	// When using the List and WatchList endpoints, provide the wildcard value "*"
	// to list resources across all peers.
	PeerName string `protobuf:"bytes,3,opt,name=peer_name,json=peerName,proto3" json:"peer_name,omitempty"`
	// contains filtered or unexported fields
}

Tenancy describes the tenancy units in which the resource resides.

func (*Tenancy) Descriptor deprecated 

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

Deprecated: Use Tenancy.ProtoReflect.Descriptor instead.

func (*Tenancy) GetNamespace 

func (x *Tenancy) GetNamespace() string

func (*Tenancy) GetPartition 

func (x *Tenancy) GetPartition() string

func (*Tenancy) GetPeerName 

func (x *Tenancy) GetPeerName() string

func (*Tenancy) MarshalBinary 

func (msg *Tenancy) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*Tenancy) ProtoMessage 

func (*Tenancy) ProtoMessage()

func (*Tenancy) ProtoReflect 

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

func (*Tenancy) Reset 

func (x *Tenancy) Reset()

func (*Tenancy) String 

func (x *Tenancy) String() string

func (*Tenancy) UnmarshalBinary 

func (msg *Tenancy) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type Tombstone 

type Tombstone struct {

	// Owner resource identifier.
	Owner *ID `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
	// contains filtered or unexported fields
}

Tombstone represents a promise to delete all of a resource's immediately owned (child) resources, if any.

func (*Tombstone) Descriptor deprecated 

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

Deprecated: Use Tombstone.ProtoReflect.Descriptor instead.

func (*Tombstone) GetOwner 

func (x *Tombstone) GetOwner() *ID

func (*Tombstone) MarshalBinary 

func (msg *Tombstone) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*Tombstone) ProtoMessage 

func (*Tombstone) ProtoMessage()

func (*Tombstone) ProtoReflect 

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

func (*Tombstone) Reset 

func (x *Tombstone) Reset()

func (*Tombstone) String 

func (x *Tombstone) String() string

func (*Tombstone) UnmarshalBinary 

func (msg *Tombstone) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type Type 

type Type struct {

	// Group describes the area of functionality to which this resource type
	// relates (e.g. "catalog", "authorization").
	Group string `protobuf:"bytes,1,opt,name=group,proto3" json:"group,omitempty"`
	// GroupVersion is incremented when sweeping or backward-incompatible changes
	// are made to the group's resource types.
	GroupVersion string `protobuf:"bytes,2,opt,name=group_version,json=groupVersion,proto3" json:"group_version,omitempty"`
	// Kind identifies the specific resource type within the group.
	Kind string `protobuf:"bytes,3,opt,name=kind,proto3" json:"kind,omitempty"`
	// contains filtered or unexported fields
}

Type describes a resource's type. It follows the GVK (Group Version Kind) [pattern](https://book.kubebuilder.io/cronjob-tutorial/gvks.html) established by Kubernetes.

func (*Type) Descriptor deprecated 

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

Deprecated: Use Type.ProtoReflect.Descriptor instead.

func (*Type) GetGroup 

func (x *Type) GetGroup() string

func (*Type) GetGroupVersion 

func (x *Type) GetGroupVersion() string

func (*Type) GetKind 

func (x *Type) GetKind() string

func (*Type) MarshalBinary 

func (msg *Type) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*Type) ProtoMessage 

func (*Type) ProtoMessage()

func (*Type) ProtoReflect 

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

func (*Type) Reset 

func (x *Type) Reset()

func (*Type) String 

func (x *Type) String() string

func (*Type) UnmarshalBinary 

func (msg *Type) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type UnimplementedResourceServiceServer 

type UnimplementedResourceServiceServer struct {
}

UnimplementedResourceServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedResourceServiceServer) Delete 

func (UnimplementedResourceServiceServer) Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)

func (UnimplementedResourceServiceServer) List 

func (UnimplementedResourceServiceServer) List(context.Context, *ListRequest) (*ListResponse, error)

func (UnimplementedResourceServiceServer) ListByOwner 

func (UnimplementedResourceServiceServer) ListByOwner(context.Context, *ListByOwnerRequest) (*ListByOwnerResponse, error)

func (UnimplementedResourceServiceServer) Read 

func (UnimplementedResourceServiceServer) Read(context.Context, *ReadRequest) (*ReadResponse, error)

func (UnimplementedResourceServiceServer) WatchList 

func (UnimplementedResourceServiceServer) WatchList(*WatchListRequest, ResourceService_WatchListServer) error

func (UnimplementedResourceServiceServer) Write 

func (UnimplementedResourceServiceServer) Write(context.Context, *WriteRequest) (*WriteResponse, error)

func (UnimplementedResourceServiceServer) WriteStatus 

func (UnimplementedResourceServiceServer) WriteStatus(context.Context, *WriteStatusRequest) (*WriteStatusResponse, error)

type UnsafeResourceServiceServer 

type UnsafeResourceServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeResourceServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ResourceServiceServer will result in compilation errors.

type WatchEvent 

type WatchEvent struct {

	// Operation describes the type of event.
	Operation WatchEvent_Operation `protobuf:"varint,1,opt,name=operation,proto3,enum=hashicorp.consul.resource.WatchEvent_Operation" json:"operation,omitempty"`
	// Resource the event relates to.
	Resource *Resource `protobuf:"bytes,2,opt,name=resource,proto3" json:"resource,omitempty"`
	// contains filtered or unexported fields
}

WatchEvent is emitted on the WatchList stream when a resource changes.

func (*WatchEvent) Descriptor deprecated 

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

Deprecated: Use WatchEvent.ProtoReflect.Descriptor instead.

func (*WatchEvent) GetOperation 

func (x *WatchEvent) GetOperation() WatchEvent_Operation

func (*WatchEvent) GetResource 

func (x *WatchEvent) GetResource() *Resource

func (*WatchEvent) MarshalBinary 

func (msg *WatchEvent) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*WatchEvent) ProtoMessage 

func (*WatchEvent) ProtoMessage()

func (*WatchEvent) ProtoReflect 

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

func (*WatchEvent) Reset 

func (x *WatchEvent) Reset()

func (*WatchEvent) String 

func (x *WatchEvent) String() string

func (*WatchEvent) UnmarshalBinary 

func (msg *WatchEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type WatchEvent_Operation 

type WatchEvent_Operation int32

Operation describes the type of event. 

const (
	// OPERATION_UNSPECIFIED is the default/zero value. You should not see it
	// in practice.
	WatchEvent_OPERATION_UNSPECIFIED WatchEvent_Operation = 0
	// OPERATION_UPSERT indicates that the resource was written (i.e. created or
	// updated). All events from the initial state-of-the-world will be upsert
	// events.
	WatchEvent_OPERATION_UPSERT WatchEvent_Operation = 1
	// OPERATION_DELETED indicates that the resource was deleted.
	WatchEvent_OPERATION_DELETE WatchEvent_Operation = 2
)

func (WatchEvent_Operation) Descriptor 

func (WatchEvent_Operation) Descriptor() protoreflect.EnumDescriptor

func (WatchEvent_Operation) Enum 

func (x WatchEvent_Operation) Enum() *WatchEvent_Operation

func (WatchEvent_Operation) EnumDescriptor deprecated 

func (WatchEvent_Operation) EnumDescriptor() ([]byte, []int)

Deprecated: Use WatchEvent_Operation.Descriptor instead.

func (WatchEvent_Operation) Number 

func (x WatchEvent_Operation) Number() protoreflect.EnumNumber

func (WatchEvent_Operation) String 

func (x WatchEvent_Operation) String() string

func (WatchEvent_Operation) Type 

func (WatchEvent_Operation) Type() protoreflect.EnumType

type WatchListRequest 

type WatchListRequest struct {

	// Type of resource to watch.
	Type *Type `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Tenancy units in which to watch resources. To list resources in all units,
	// provide the wildcard "*" value.
	Tenancy *Tenancy `protobuf:"bytes,2,opt,name=tenancy,proto3" json:"tenancy,omitempty"`
	// NamePrefix filters the results to those with a name beginning with the
	// given prefix.
	NamePrefix string `protobuf:"bytes,3,opt,name=name_prefix,json=namePrefix,proto3" json:"name_prefix,omitempty"`
	// contains filtered or unexported fields
}

WatchListRequest contains the parameters to the WatchList endpoint.

func (*WatchListRequest) Descriptor deprecated 

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

Deprecated: Use WatchListRequest.ProtoReflect.Descriptor instead.

func (*WatchListRequest) GetNamePrefix 

func (x *WatchListRequest) GetNamePrefix() string

func (*WatchListRequest) GetTenancy 

func (x *WatchListRequest) GetTenancy() *Tenancy

func (*WatchListRequest) GetType 

func (x *WatchListRequest) GetType() *Type

func (*WatchListRequest) MarshalBinary 

func (msg *WatchListRequest) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*WatchListRequest) ProtoMessage 

func (*WatchListRequest) ProtoMessage()

func (*WatchListRequest) ProtoReflect 

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

func (*WatchListRequest) Reset 

func (x *WatchListRequest) Reset()

func (*WatchListRequest) String 

func (x *WatchListRequest) String() string

func (*WatchListRequest) UnmarshalBinary 

func (msg *WatchListRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type WriteRequest 

type WriteRequest struct {

	// Resource to write.
	Resource *Resource `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
	// contains filtered or unexported fields
}

WriteRequest contains the parameters to the Write endpoint.

func (*WriteRequest) Descriptor deprecated 

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

Deprecated: Use WriteRequest.ProtoReflect.Descriptor instead.

func (*WriteRequest) GetResource 

func (x *WriteRequest) GetResource() *Resource

func (*WriteRequest) MarshalBinary 

func (msg *WriteRequest) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*WriteRequest) ProtoMessage 

func (*WriteRequest) ProtoMessage()

func (*WriteRequest) ProtoReflect 

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

func (*WriteRequest) Reset 

func (x *WriteRequest) Reset()

func (*WriteRequest) String 

func (x *WriteRequest) String() string

func (*WriteRequest) UnmarshalBinary 

func (msg *WriteRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type WriteResponse 

type WriteResponse struct {

	// Resource that was written.
	Resource *Resource `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
	// contains filtered or unexported fields
}

WriteResponse contains the results of calling the Write endpoint.

func (*WriteResponse) Descriptor deprecated 

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

Deprecated: Use WriteResponse.ProtoReflect.Descriptor instead.

func (*WriteResponse) GetResource 

func (x *WriteResponse) GetResource() *Resource

func (*WriteResponse) MarshalBinary 

func (msg *WriteResponse) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*WriteResponse) ProtoMessage 

func (*WriteResponse) ProtoMessage()

func (*WriteResponse) ProtoReflect 

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

func (*WriteResponse) Reset 

func (x *WriteResponse) Reset()

func (*WriteResponse) String 

func (x *WriteResponse) String() string

func (*WriteResponse) UnmarshalBinary 

func (msg *WriteResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type WriteStatusRequest 

type WriteStatusRequest struct {

	// ID of the resource to which the status will be written. Must contain a Uid.
	Id *ID `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Version may be provided to perform a CAS (Compare-And-Swap) update of the
	// status. If the given version doesn't match what is currently stored, an
	// Aborted error code will be returned.
	//
	// Note: in most cases, CAS status updates are not necessary because updates
	// are scoped to a specific status key and controllers are leader-elected so
	// there is no chance of a conflict.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// Key identifies which status will be written. Generally, each controller
	// should write 1 status which it owns exclusively (i.e. no other controller
	// updates it).
	Key string `protobuf:"bytes,3,opt,name=key,proto3" json:"key,omitempty"`
	// Status that will be written to the resource.
	Status *Status `protobuf:"bytes,4,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

WriteStatusRequest contains the parameters to the WriteStatus endpoint.

func (*WriteStatusRequest) Descriptor deprecated 

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

Deprecated: Use WriteStatusRequest.ProtoReflect.Descriptor instead.

func (*WriteStatusRequest) GetId 

func (x *WriteStatusRequest) GetId() *ID

func (*WriteStatusRequest) GetKey 

func (x *WriteStatusRequest) GetKey() string

func (*WriteStatusRequest) GetStatus 

func (x *WriteStatusRequest) GetStatus() *Status

func (*WriteStatusRequest) GetVersion 

func (x *WriteStatusRequest) GetVersion() string

func (*WriteStatusRequest) MarshalBinary 

func (msg *WriteStatusRequest) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*WriteStatusRequest) ProtoMessage 

func (*WriteStatusRequest) ProtoMessage()

func (*WriteStatusRequest) ProtoReflect 

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

func (*WriteStatusRequest) Reset 

func (x *WriteStatusRequest) Reset()

func (*WriteStatusRequest) String 

func (x *WriteStatusRequest) String() string

func (*WriteStatusRequest) UnmarshalBinary 

func (msg *WriteStatusRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

type WriteStatusResponse 

type WriteStatusResponse struct {

	// Resource to which the status was written.
	Resource *Resource `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
	// contains filtered or unexported fields
}

WriteStatusResponse contains the results of calling the WriteStatus endpoint.

func (*WriteStatusResponse) Descriptor deprecated 

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

Deprecated: Use WriteStatusResponse.ProtoReflect.Descriptor instead.

func (*WriteStatusResponse) GetResource 

func (x *WriteStatusResponse) GetResource() *Resource

func (*WriteStatusResponse) MarshalBinary 

func (msg *WriteStatusResponse) MarshalBinary() ([]byte, error)

MarshalBinary implements encoding.BinaryMarshaler

func (*WriteStatusResponse) ProtoMessage 

func (*WriteStatusResponse) ProtoMessage()

func (*WriteStatusResponse) ProtoReflect 

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

func (*WriteStatusResponse) Reset 

func (x *WriteStatusResponse) Reset()

func (*WriteStatusResponse) String 

func (x *WriteStatusResponse) String() string

func (*WriteStatusResponse) UnmarshalBinary 

func (msg *WriteStatusResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary implements encoding.BinaryUnmarshaler

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.