Struct DescribeTaskQueueRequest 

pub struct DescribeTaskQueueRequest {
    pub namespace: String,
    pub task_queue: Option<TaskQueue>,
    pub task_queue_type: i32,
    pub report_stats: bool,
    pub report_config: bool,
    pub include_task_queue_status: bool,
    pub api_mode: i32,
    pub versions: Option<TaskQueueVersionSelection>,
    pub task_queue_types: Vec<i32>,
    pub report_pollers: bool,
    pub report_task_reachability: bool,
}

(– api-linter: core::0203::optional=disabled aip.dev/not-precedent: field_behavior annotation not available in our gogo fork –)

Fields

namespace: String

task_queue: Option<TaskQueue>

Sticky queues are not supported in deprecated ENHANCED mode.

task_queue_type: i32

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

report_stats: bool

Report stats for the requested task queue type(s).

report_config: bool

Report Task Queue Config

include_task_queue_status: bool

👎Deprecated

Deprecated, use report_stats instead. If true, the task queue status will be included in the response.

api_mode: i32

👎Deprecated

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.

versions: Option<TaskQueueVersionSelection>

👎Deprecated

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

task_queue_types: Vec<i32>

👎Deprecated

Deprecated (as part of the ENHANCED mode deprecation). Task queue types to report info about. If not specified, all types are considered.

report_pollers: bool

👎Deprecated

Deprecated (as part of the ENHANCED mode deprecation). Report list of pollers for requested task queue types and versions.

report_task_reachability: bool

👎Deprecated

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

Implementations

impl DescribeTaskQueueRequest

pub fn task_queue_type(&self) -> TaskQueueType

Returns the enum value of task_queue_type, or the default if the field is set to an invalid enum value.

pub fn set_task_queue_type(&mut self, value: TaskQueueType)

Sets task_queue_type to the provided enum value.

pub fn api_mode(&self) -> DescribeTaskQueueMode

Returns the enum value of api_mode, or the default if the field is set to an invalid enum value.

pub fn set_api_mode(&mut self, value: DescribeTaskQueueMode)

Sets api_mode to the provided enum value.

pub fn task_queue_types( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(i32) -> Option<TaskQueueType>>

Returns an iterator which yields the valid enum values contained in task_queue_types.

pub fn push_task_queue_types(&mut self, value: TaskQueueType)

Appends the provided enum value to task_queue_types.

Trait Implementations

impl Clone for DescribeTaskQueueRequest

fn clone(&self) -> DescribeTaskQueueRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeTaskQueueRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DescribeTaskQueueRequest

fn default() -> Self

Returns the “default value” for a type.

impl Hash for DescribeTaskQueueRequest

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for DescribeTaskQueueRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for DescribeTaskQueueRequest

const NAME: &'static str = "DescribeTaskQueueRequest"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "temporal.api.workflowservice.v1"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for DescribeTaskQueueRequest

fn eq(&self, other: &DescribeTaskQueueRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DescribeTaskQueueRequest

impl StructuralPartialEq for DescribeTaskQueueRequest