Class: PermissionDeniedFailure
errordetails.v1.PermissionDeniedFailure
Represents a PermissionDeniedFailure.
Implements
Constructors
constructor
• new PermissionDeniedFailure(properties?
): PermissionDeniedFailure
Constructs a new PermissionDeniedFailure.
Parameters
Name | Type | Description |
---|---|---|
properties? | IPermissionDeniedFailure | Properties to set |
Returns
Properties
reason
• reason: string
PermissionDeniedFailure reason.
Implementation of
IPermissionDeniedFailure.reason
Methods
toJSON
▸ toJSON(): Object
Converts this PermissionDeniedFailure to JSON.
Returns
Object
JSON object
create
▸ create(properties?
): PermissionDeniedFailure
Creates a new PermissionDeniedFailure instance using the specified properties.
Parameters
Name | Type | Description |
---|---|---|
properties? | IPermissionDeniedFailure | Properties to set |
Returns
PermissionDeniedFailure instance
decode
▸ decode(reader
, length?
): PermissionDeniedFailure
Decodes a PermissionDeniedFailure message from the specified reader or buffer.
Parameters
Name | Type | Description |
---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
PermissionDeniedFailure
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader
): PermissionDeniedFailure
Decodes a PermissionDeniedFailure message from the specified reader or buffer, length delimited.
Parameters
Name | Type | Description |
---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PermissionDeniedFailure
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message
, writer?
): Writer
Encodes the specified PermissionDeniedFailure message. Does not implicitly temporal.api.errordetails.v1.PermissionDeniedFailure.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | IPermissionDeniedFailure | PermissionDeniedFailure message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message
, writer?
): Writer
Encodes the specified PermissionDeniedFailure message, length delimited. Does not implicitly temporal.api.errordetails.v1.PermissionDeniedFailure.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | IPermissionDeniedFailure | PermissionDeniedFailure message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object
): PermissionDeniedFailure
Creates a PermissionDeniedFailure message from a plain object. Also converts values to their respective internal types.
Parameters
Name | Type | Description |
---|---|---|
object | Object | Plain object |
Returns
PermissionDeniedFailure
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?
): string
Gets the default type url for PermissionDeniedFailure
Parameters
Name | Type | Description |
---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message
, options?
): Object
Creates a plain object from a PermissionDeniedFailure message. Also converts values to other types if specified.
Parameters
Name | Type | Description |
---|---|---|
message | PermissionDeniedFailure | PermissionDeniedFailure |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object