Documentation
¶
Index ¶
- Variables
- type AllowedCloudNamespacePolicySpec
- func (*AllowedCloudNamespacePolicySpec) Descriptor() ([]byte, []int)deprecated
- func (x *AllowedCloudNamespacePolicySpec) GetNamespaceId() string
- func (*AllowedCloudNamespacePolicySpec) ProtoMessage()
- func (x *AllowedCloudNamespacePolicySpec) ProtoReflect() protoreflect.Message
- func (x *AllowedCloudNamespacePolicySpec) Reset()
- func (x *AllowedCloudNamespacePolicySpec) String() string
- type Endpoint
- func (*Endpoint) Descriptor() ([]byte, []int)deprecated
- func (x *Endpoint) GetAsyncOperationId() string
- func (x *Endpoint) GetCreatedTime() *timestamppb.Timestamp
- func (x *Endpoint) GetId() string
- func (x *Endpoint) GetLastModifiedTime() *timestamppb.Timestamp
- func (x *Endpoint) GetResourceVersion() string
- func (x *Endpoint) GetSpec() *EndpointSpec
- func (x *Endpoint) GetState() v11.ResourceState
- func (*Endpoint) ProtoMessage()
- func (x *Endpoint) ProtoReflect() protoreflect.Message
- func (x *Endpoint) Reset()
- func (x *Endpoint) String() string
- type EndpointPolicySpec
- func (*EndpointPolicySpec) Descriptor() ([]byte, []int)deprecated
- func (x *EndpointPolicySpec) GetAllowedCloudNamespacePolicySpec() *AllowedCloudNamespacePolicySpec
- func (x *EndpointPolicySpec) GetVariant() isEndpointPolicySpec_Variant
- func (*EndpointPolicySpec) ProtoMessage()
- func (x *EndpointPolicySpec) ProtoReflect() protoreflect.Message
- func (x *EndpointPolicySpec) Reset()
- func (x *EndpointPolicySpec) String() string
- type EndpointPolicySpec_AllowedCloudNamespacePolicySpec
- type EndpointSpec
- func (*EndpointSpec) Descriptor() ([]byte, []int)deprecated
- func (x *EndpointSpec) GetDescription() *v1.Payload
- func (x *EndpointSpec) GetDescriptionDeprecated() stringdeprecated
- func (x *EndpointSpec) GetName() string
- func (x *EndpointSpec) GetPolicySpecs() []*EndpointPolicySpec
- func (x *EndpointSpec) GetTargetSpec() *EndpointTargetSpec
- func (*EndpointSpec) ProtoMessage()
- func (x *EndpointSpec) ProtoReflect() protoreflect.Message
- func (x *EndpointSpec) Reset()
- func (x *EndpointSpec) String() string
- type EndpointTargetSpec
- func (*EndpointTargetSpec) Descriptor() ([]byte, []int)deprecated
- func (x *EndpointTargetSpec) GetVariant() isEndpointTargetSpec_Variant
- func (x *EndpointTargetSpec) GetWorkerTargetSpec() *WorkerTargetSpec
- func (*EndpointTargetSpec) ProtoMessage()
- func (x *EndpointTargetSpec) ProtoReflect() protoreflect.Message
- func (x *EndpointTargetSpec) Reset()
- func (x *EndpointTargetSpec) String() string
- type EndpointTargetSpec_WorkerTargetSpec
- type WorkerTargetSpec
- func (*WorkerTargetSpec) Descriptor() ([]byte, []int)deprecated
- func (x *WorkerTargetSpec) GetNamespaceId() string
- func (x *WorkerTargetSpec) GetTaskQueue() string
- func (*WorkerTargetSpec) ProtoMessage()
- func (x *WorkerTargetSpec) ProtoReflect() protoreflect.Message
- func (x *WorkerTargetSpec) Reset()
- func (x *WorkerTargetSpec) String() string
Constants ¶
This section is empty.
Variables ¶
View Source
var File_temporal_api_cloud_nexus_v1_message_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type AllowedCloudNamespacePolicySpec ¶
type AllowedCloudNamespacePolicySpec struct { // The namespace that is allowed to call into this endpoint. Calling namespace must be in same account as the endpoint. NamespaceId string `protobuf:"bytes,1,opt,name=namespace_id,json=namespaceId,proto3" json:"namespace_id,omitempty"` // contains filtered or unexported fields }
func (*AllowedCloudNamespacePolicySpec) Descriptor
deprecated
func (*AllowedCloudNamespacePolicySpec) Descriptor() ([]byte, []int)
Deprecated: Use AllowedCloudNamespacePolicySpec.ProtoReflect.Descriptor instead.
func (*AllowedCloudNamespacePolicySpec) GetNamespaceId ¶
func (x *AllowedCloudNamespacePolicySpec) GetNamespaceId() string
func (*AllowedCloudNamespacePolicySpec) ProtoMessage ¶
func (*AllowedCloudNamespacePolicySpec) ProtoMessage()
func (*AllowedCloudNamespacePolicySpec) ProtoReflect ¶
func (x *AllowedCloudNamespacePolicySpec) ProtoReflect() protoreflect.Message
func (*AllowedCloudNamespacePolicySpec) Reset ¶
func (x *AllowedCloudNamespacePolicySpec) Reset()
func (*AllowedCloudNamespacePolicySpec) String ¶
func (x *AllowedCloudNamespacePolicySpec) String() string
type Endpoint ¶
type Endpoint struct { // The id of the endpoint. This is generated by the server and is immutable. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // The current version of the endpoint specification. // The next update operation must include this version. ResourceVersion string `protobuf:"bytes,2,opt,name=resource_version,json=resourceVersion,proto3" json:"resource_version,omitempty"` // The endpoint specification. Spec *EndpointSpec `protobuf:"bytes,3,opt,name=spec,proto3" json:"spec,omitempty"` // The current state of the endpoint. // For any failed state, reach out to Temporal Cloud support for remediation. State v11.ResourceState `protobuf:"varint,4,opt,name=state,proto3,enum=temporal.api.cloud.resource.v1.ResourceState" json:"state,omitempty"` // The id of any ongoing async operation that is creating, updating, or deleting the endpoint, if any. AsyncOperationId string `protobuf:"bytes,5,opt,name=async_operation_id,json=asyncOperationId,proto3" json:"async_operation_id,omitempty"` // The date and time when the endpoint was created. CreatedTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=created_time,json=createdTime,proto3" json:"created_time,omitempty"` // The date and time when the endpoint was last modified. LastModifiedTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=last_modified_time,json=lastModifiedTime,proto3" json:"last_modified_time,omitempty"` // contains filtered or unexported fields }
An endpoint that receives and then routes Nexus requests
func (*Endpoint) Descriptor
deprecated
func (*Endpoint) GetAsyncOperationId ¶
func (*Endpoint) GetCreatedTime ¶
func (x *Endpoint) GetCreatedTime() *timestamppb.Timestamp
func (*Endpoint) GetLastModifiedTime ¶
func (x *Endpoint) GetLastModifiedTime() *timestamppb.Timestamp
func (*Endpoint) GetResourceVersion ¶
func (*Endpoint) GetSpec ¶
func (x *Endpoint) GetSpec() *EndpointSpec
func (*Endpoint) GetState ¶
func (x *Endpoint) GetState() v11.ResourceState
func (*Endpoint) ProtoMessage ¶
func (*Endpoint) ProtoMessage()
func (*Endpoint) ProtoReflect ¶
func (x *Endpoint) ProtoReflect() protoreflect.Message
type EndpointPolicySpec ¶
type EndpointPolicySpec struct { // Types that are valid to be assigned to Variant: // // *EndpointPolicySpec_AllowedCloudNamespacePolicySpec Variant isEndpointPolicySpec_Variant `protobuf_oneof:"variant"` // contains filtered or unexported fields }
func (*EndpointPolicySpec) Descriptor
deprecated
func (*EndpointPolicySpec) Descriptor() ([]byte, []int)
Deprecated: Use EndpointPolicySpec.ProtoReflect.Descriptor instead.
func (*EndpointPolicySpec) GetAllowedCloudNamespacePolicySpec ¶
func (x *EndpointPolicySpec) GetAllowedCloudNamespacePolicySpec() *AllowedCloudNamespacePolicySpec
func (*EndpointPolicySpec) GetVariant ¶
func (x *EndpointPolicySpec) GetVariant() isEndpointPolicySpec_Variant
func (*EndpointPolicySpec) ProtoMessage ¶
func (*EndpointPolicySpec) ProtoMessage()
func (*EndpointPolicySpec) ProtoReflect ¶
func (x *EndpointPolicySpec) ProtoReflect() protoreflect.Message
func (*EndpointPolicySpec) Reset ¶
func (x *EndpointPolicySpec) Reset()
func (*EndpointPolicySpec) String ¶
func (x *EndpointPolicySpec) String() string
type EndpointPolicySpec_AllowedCloudNamespacePolicySpec ¶
type EndpointPolicySpec_AllowedCloudNamespacePolicySpec struct { // A policy spec that allows one caller namespace to access the endpoint. AllowedCloudNamespacePolicySpec *AllowedCloudNamespacePolicySpec `protobuf:"bytes,1,opt,name=allowed_cloud_namespace_policy_spec,json=allowedCloudNamespacePolicySpec,proto3,oneof"` }
type EndpointSpec ¶
type EndpointSpec struct { // The name of the endpoint. Must be unique within an account. // The name must match `^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$`. // This field is mutable. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Indicates where the endpoint should forward received nexus requests to. TargetSpec *EndpointTargetSpec `protobuf:"bytes,2,opt,name=target_spec,json=targetSpec,proto3" json:"target_spec,omitempty"` // The set of policies (e.g. authorization) for the endpoint. Each request's caller // must match with at least one of the specs to be accepted by the endpoint. // This field is mutable. PolicySpecs []*EndpointPolicySpec `protobuf:"bytes,3,rep,name=policy_specs,json=policySpecs,proto3" json:"policy_specs,omitempty"` // Deprecated: Not supported after v0.4.0 api version. Use description instead. // temporal:versioning:max_version=v0.4.0 // // Deprecated: Marked as deprecated in temporal/api/cloud/nexus/v1/message.proto. DescriptionDeprecated string `protobuf:"bytes,4,opt,name=description_deprecated,json=descriptionDeprecated,proto3" json:"description_deprecated,omitempty"` // The markdown description of the endpoint - optional. // temporal:versioning:min_version=v0.4.0 Description *v1.Payload `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"` // contains filtered or unexported fields }
func (*EndpointSpec) Descriptor
deprecated
func (*EndpointSpec) Descriptor() ([]byte, []int)
Deprecated: Use EndpointSpec.ProtoReflect.Descriptor instead.
func (*EndpointSpec) GetDescription ¶
func (x *EndpointSpec) GetDescription() *v1.Payload
func (*EndpointSpec) GetDescriptionDeprecated
deprecated
added in
v0.2.0
func (x *EndpointSpec) GetDescriptionDeprecated() string
Deprecated: Marked as deprecated in temporal/api/cloud/nexus/v1/message.proto.
func (*EndpointSpec) GetName ¶
func (x *EndpointSpec) GetName() string
func (*EndpointSpec) GetPolicySpecs ¶
func (x *EndpointSpec) GetPolicySpecs() []*EndpointPolicySpec
func (*EndpointSpec) GetTargetSpec ¶
func (x *EndpointSpec) GetTargetSpec() *EndpointTargetSpec
func (*EndpointSpec) ProtoMessage ¶
func (*EndpointSpec) ProtoMessage()
func (*EndpointSpec) ProtoReflect ¶
func (x *EndpointSpec) ProtoReflect() protoreflect.Message
func (*EndpointSpec) Reset ¶
func (x *EndpointSpec) Reset()
func (*EndpointSpec) String ¶
func (x *EndpointSpec) String() string
type EndpointTargetSpec ¶
type EndpointTargetSpec struct { // Types that are valid to be assigned to Variant: // // *EndpointTargetSpec_WorkerTargetSpec Variant isEndpointTargetSpec_Variant `protobuf_oneof:"variant"` // contains filtered or unexported fields }
func (*EndpointTargetSpec) Descriptor
deprecated
func (*EndpointTargetSpec) Descriptor() ([]byte, []int)
Deprecated: Use EndpointTargetSpec.ProtoReflect.Descriptor instead.
func (*EndpointTargetSpec) GetVariant ¶
func (x *EndpointTargetSpec) GetVariant() isEndpointTargetSpec_Variant
func (*EndpointTargetSpec) GetWorkerTargetSpec ¶
func (x *EndpointTargetSpec) GetWorkerTargetSpec() *WorkerTargetSpec
func (*EndpointTargetSpec) ProtoMessage ¶
func (*EndpointTargetSpec) ProtoMessage()
func (*EndpointTargetSpec) ProtoReflect ¶
func (x *EndpointTargetSpec) ProtoReflect() protoreflect.Message
func (*EndpointTargetSpec) Reset ¶
func (x *EndpointTargetSpec) Reset()
func (*EndpointTargetSpec) String ¶
func (x *EndpointTargetSpec) String() string
type EndpointTargetSpec_WorkerTargetSpec ¶
type EndpointTargetSpec_WorkerTargetSpec struct { // A target spec for routing nexus requests to a specific cloud namespace worker. WorkerTargetSpec *WorkerTargetSpec `protobuf:"bytes,1,opt,name=worker_target_spec,json=workerTargetSpec,proto3,oneof"` }
type WorkerTargetSpec ¶
type WorkerTargetSpec struct { // The target cloud namespace to route requests to. Namespace must be in same account as the endpoint. This field is mutable. NamespaceId string `protobuf:"bytes,1,opt,name=namespace_id,json=namespaceId,proto3" json:"namespace_id,omitempty"` // The task queue on the cloud namespace to route requests to. This field is mutable. TaskQueue string `protobuf:"bytes,2,opt,name=task_queue,json=taskQueue,proto3" json:"task_queue,omitempty"` // contains filtered or unexported fields }
func (*WorkerTargetSpec) Descriptor
deprecated
func (*WorkerTargetSpec) Descriptor() ([]byte, []int)
Deprecated: Use WorkerTargetSpec.ProtoReflect.Descriptor instead.
func (*WorkerTargetSpec) GetNamespaceId ¶
func (x *WorkerTargetSpec) GetNamespaceId() string
func (*WorkerTargetSpec) GetTaskQueue ¶
func (x *WorkerTargetSpec) GetTaskQueue() string
func (*WorkerTargetSpec) ProtoMessage ¶
func (*WorkerTargetSpec) ProtoMessage()
func (*WorkerTargetSpec) ProtoReflect ¶
func (x *WorkerTargetSpec) ProtoReflect() protoreflect.Message
func (*WorkerTargetSpec) Reset ¶
func (x *WorkerTargetSpec) Reset()
func (*WorkerTargetSpec) String ¶
func (x *WorkerTargetSpec) String() string
Click to show internal directories.
Click to hide internal directories.