Class DescribeTaskQueueRequest
- Namespace
- Temporalio.Api.WorkflowService.V1
- Assembly
- Temporalio.dll
(-- api-linter: core::0203::optional=disabled aip.dev/not-precedent: field_behavior annotation not available in our gogo fork --)
public sealed class DescribeTaskQueueRequest : IMessage<DescribeTaskQueueRequest>, IEquatable<DescribeTaskQueueRequest>, IDeepCloneable<DescribeTaskQueueRequest>, IBufferMessage, IMessage
- Inheritance
-
DescribeTaskQueueRequest
- Implements
-
IMessage<DescribeTaskQueueRequest>IDeepCloneable<DescribeTaskQueueRequest>IBufferMessageIMessage
- Inherited Members
Constructors
DescribeTaskQueueRequest()
public DescribeTaskQueueRequest()
DescribeTaskQueueRequest(DescribeTaskQueueRequest)
public DescribeTaskQueueRequest(DescribeTaskQueueRequest other)
Parameters
other
DescribeTaskQueueRequest
Fields
ApiModeFieldNumber
Field number for the "api_mode" field.
public const int ApiModeFieldNumber = 5
Field Value
IncludeTaskQueueStatusFieldNumber
Field number for the "include_task_queue_status" field.
public const int IncludeTaskQueueStatusFieldNumber = 4
Field Value
NamespaceFieldNumber
Field number for the "namespace" field.
public const int NamespaceFieldNumber = 1
Field Value
ReportPollersFieldNumber
Field number for the "report_pollers" field.
public const int ReportPollersFieldNumber = 9
Field Value
ReportStatsFieldNumber
Field number for the "report_stats" field.
public const int ReportStatsFieldNumber = 8
Field Value
ReportTaskReachabilityFieldNumber
Field number for the "report_task_reachability" field.
public const int ReportTaskReachabilityFieldNumber = 10
Field Value
TaskQueueFieldNumber
Field number for the "task_queue" field.
public const int TaskQueueFieldNumber = 2
Field Value
TaskQueueTypeFieldNumber
Field number for the "task_queue_type" field.
public const int TaskQueueTypeFieldNumber = 3
Field Value
TaskQueueTypesFieldNumber
Field number for the "task_queue_types" field.
public const int TaskQueueTypesFieldNumber = 7
Field Value
VersionsFieldNumber
Field number for the "versions" field.
public const int VersionsFieldNumber = 6
Field Value
Properties
ApiMode
Deprecated. ENHANCED mode is also being deprecated. Select the API mode to use for this request: DEFAULT mode (if unset) or ENHANCED mode. Consult the documentation for each field to understand which mode it is supported in.
[Obsolete]
public DescribeTaskQueueMode ApiMode { get; set; }
Property Value
Descriptor
public static MessageDescriptor Descriptor { get; }
Property Value
- MessageDescriptor
IncludeTaskQueueStatus
Deprecated, use report_stats
instead.
If true, the task queue status will be included in the response.
[Obsolete]
public bool IncludeTaskQueueStatus { get; set; }
Property Value
Namespace
public string Namespace { get; set; }
Property Value
Parser
public static MessageParser<DescribeTaskQueueRequest> Parser { get; }
Property Value
- MessageParser<DescribeTaskQueueRequest>
ReportPollers
Deprecated (as part of the ENHANCED mode deprecation). Report list of pollers for requested task queue types and versions.
[Obsolete]
public bool ReportPollers { get; set; }
Property Value
ReportStats
Report stats for the requested task queue type(s).
public bool ReportStats { get; set; }
Property Value
ReportTaskReachability
Deprecated (as part of the ENHANCED mode deprecation). Report task reachability for the requested versions and all task types (task reachability is not reported per task type).
[Obsolete]
public bool ReportTaskReachability { get; set; }
Property Value
TaskQueue
Sticky queues are not supported in deprecated ENHANCED mode.
public TaskQueue TaskQueue { get; set; }
Property Value
TaskQueueType
If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.
Only supported in default mode (use task_queue_types
in ENHANCED mode instead).
public TaskQueueType TaskQueueType { get; set; }
Property Value
TaskQueueTypes
Deprecated (as part of the ENHANCED mode deprecation). Task queue types to report info about. If not specified, all types are considered.
[Obsolete]
public RepeatedField<TaskQueueType> TaskQueueTypes { get; }
Property Value
- RepeatedField<TaskQueueType>
Versions
Deprecated (as part of the ENHANCED mode deprecation). Optional. If not provided, the result for the default Build ID will be returned. The default Build ID is the one mentioned in the first unconditional Assignment Rule. If there is no default Build ID, the result for the unversioned queue will be returned. (-- api-linter: core::0140::prepositions --)
[Obsolete]
public TaskQueueVersionSelection Versions { get; set; }
Property Value
Methods
CalculateSize()
Calculates the size of this message in Protocol Buffer wire format, in bytes.
public int CalculateSize()
Returns
- int
The number of bytes required to write this message to a coded output stream.
Clone()
Creates a deep clone of this object.
public DescribeTaskQueueRequest Clone()
Returns
- DescribeTaskQueueRequest
A deep clone of this object.
Equals(object)
Determines whether the specified object is equal to the current object.
public override bool Equals(object other)
Parameters
other
object
Returns
Equals(DescribeTaskQueueRequest)
Indicates whether the current object is equal to another object of the same type.
public bool Equals(DescribeTaskQueueRequest other)
Parameters
other
DescribeTaskQueueRequestAn object to compare with this object.
Returns
GetHashCode()
Serves as the default hash function.
public override int GetHashCode()
Returns
- int
A hash code for the current object.
MergeFrom(CodedInputStream)
Merges the data from the specified coded input stream with the current message.
public void MergeFrom(CodedInputStream input)
Parameters
input
CodedInputStream
Remarks
See the user guide for precise merge semantics.
MergeFrom(DescribeTaskQueueRequest)
Merges the given message into this one.
public void MergeFrom(DescribeTaskQueueRequest other)
Parameters
other
DescribeTaskQueueRequest
Remarks
See the user guide for precise merge semantics.
ToString()
Returns a string that represents the current object.
public override string ToString()
Returns
- string
A string that represents the current object.
WriteTo(CodedOutputStream)
Writes the data to the given coded output stream.
public void WriteTo(CodedOutputStream output)
Parameters
output
CodedOutputStreamCoded output stream to write the data to. Must not be null.