Class ProviderProfileCredential
- Namespace
- Openshell.V1
- Assembly
- OpenShell.Sdk.dll
Provider credential declaration.
public sealed class ProviderProfileCredential : IMessage<ProviderProfileCredential>, IEquatable<ProviderProfileCredential>, IDeepCloneable<ProviderProfileCredential>, IBufferMessage, IMessage
- Inheritance
-
ProviderProfileCredential
- Implements
-
IMessage<ProviderProfileCredential>IDeepCloneable<ProviderProfileCredential>IBufferMessageIMessage
- Inherited Members
Constructors
ProviderProfileCredential()
public ProviderProfileCredential()
ProviderProfileCredential(ProviderProfileCredential)
public ProviderProfileCredential(ProviderProfileCredential other)
Parameters
Fields
AuthStyleFieldNumber
Field number for the "auth_style" field.
public const int AuthStyleFieldNumber = 5
Field Value
DescriptionFieldNumber
Field number for the "description" field.
public const int DescriptionFieldNumber = 2
Field Value
EnvVarsFieldNumber
Field number for the "env_vars" field.
public const int EnvVarsFieldNumber = 3
Field Value
HeaderNameFieldNumber
Field number for the "header_name" field.
public const int HeaderNameFieldNumber = 6
Field Value
NameFieldNumber
Field number for the "name" field.
public const int NameFieldNumber = 1
Field Value
PathTemplateFieldNumber
Field number for the "path_template" field.
public const int PathTemplateFieldNumber = 9
Field Value
QueryParamFieldNumber
Field number for the "query_param" field.
public const int QueryParamFieldNumber = 7
Field Value
RefreshFieldNumber
Field number for the "refresh" field.
public const int RefreshFieldNumber = 8
Field Value
RequiredFieldNumber
Field number for the "required" field.
public const int RequiredFieldNumber = 4
Field Value
StablePlaceholderFieldNumber
Field number for the "stable_placeholder" field.
public const int StablePlaceholderFieldNumber = 12
Field Value
TokenGrantFieldNumber
Field number for the "token_grant" field.
public const int TokenGrantFieldNumber = 10
Field Value
TokenGrantOwnersFieldNumber
Field number for the "token_grant_owners" field.
public const int TokenGrantOwnersFieldNumber = 11
Field Value
Properties
AuthStyle
public string AuthStyle { get; set; }
Property Value
Description
public string Description { get; set; }
Property Value
Descriptor
public static MessageDescriptor Descriptor { get; }
Property Value
- MessageDescriptor
EnvVars
public RepeatedField<string> EnvVars { get; }
Property Value
- RepeatedField<string>
HeaderName
public string HeaderName { get; set; }
Property Value
Name
public string Name { get; set; }
Property Value
Parser
public static MessageParser<ProviderProfileCredential> Parser { get; }
Property Value
- MessageParser<ProviderProfileCredential>
PathTemplate
public string PathTemplate { get; set; }
Property Value
QueryParam
public string QueryParam { get; set; }
Property Value
Refresh
public ProviderCredentialRefresh Refresh { get; set; }
Property Value
Required
public bool Required { get; set; }
Property Value
StablePlaceholder
Opt in to an opaque identity-bound environment placeholder for every env var declared by this credential. Use this only when an external credential updater requires one placeholder across value-only provider revisions. Gateway-managed refresh and token-grant credentials cannot opt in because they require identity-bearing handles for authorization-epoch revocation.
public bool StablePlaceholder { get; set; }
Property Value
TokenGrant
public ProviderCredentialTokenGrant TokenGrant { get; set; }
Property Value
TokenGrantOwners
Output-only gateway-derived endpoint authorities for resolved token grants. For inspected L7 requests, empty means no endpoint may obtain this grant. L4 injection uses selectors without checking these authorities. Profile-authored values are ignored; normal policies name the originating provider endpoint, while a global policy uses its own endpoint authorities.
public RepeatedField<string> TokenGrantOwners { get; }
Property Value
- RepeatedField<string>
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 ProviderProfileCredential Clone()
Returns
- ProviderProfileCredential
A deep clone of this object.
Equals(ProviderProfileCredential)
Indicates whether the current object is equal to another object of the same type.
public bool Equals(ProviderProfileCredential other)
Parameters
otherProviderProfileCredentialAn object to compare with this object.
Returns
Equals(object)
Determines whether the specified object is equal to the current object.
public override bool Equals(object other)
Parameters
otherobject
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
inputCodedInputStream
Remarks
See the user guide for precise merge semantics.
MergeFrom(ProviderProfileCredential)
Merges the given message into this one.
public void MergeFrom(ProviderProfileCredential other)
Parameters
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
outputCodedOutputStreamCoded output stream to write the data to. Must not be null.