Class S3Spec

Namespace

Temporalio.Api.Cloud.Sink.V1

Assembly

Temporalio.dll

public sealed class S3Spec : IMessage<S3Spec>, IEquatable<S3Spec>, IDeepCloneable<S3Spec>, IBufferMessage, IMessage

Inheritance

object

S3Spec

Implements

IMessage<S3Spec>

IEquatable<S3Spec>

IDeepCloneable<S3Spec>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

S3Spec()

public S3Spec()

S3Spec(S3Spec)

public S3Spec(S3Spec other)

Parameters

other S3Spec

Fields

AwsAccountIdFieldNumber

Field number for the "aws_account_id" field.

public const int AwsAccountIdFieldNumber = 5

Field Value

int

BucketNameFieldNumber

Field number for the "bucket_name" field.

public const int BucketNameFieldNumber = 2

Field Value

int

KmsArnFieldNumber

Field number for the "kms_arn" field.

public const int KmsArnFieldNumber = 4

Field Value

int

RegionFieldNumber

Field number for the "region" field.

public const int RegionFieldNumber = 3

Field Value

int

RoleNameFieldNumber

Field number for the "role_name" field.

public const int RoleNameFieldNumber = 1

Field Value

int

Properties

AwsAccountId

The AWS account ID associated with the S3 bucket and the assumed role.

public string AwsAccountId { get; set; }

Property Value

string

BucketName

The name of the destination S3 bucket where Temporal will send data.

public string BucketName { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

KmsArn

The AWS Key Management Service (KMS) ARN used for encryption.

public string KmsArn { get; set; }

Property Value

string

Parser

public static MessageParser<S3Spec> Parser { get; }

Property Value

MessageParser<S3Spec>

Region

The region where the S3 bucket is located.

public string Region { get; set; }

Property Value

string

RoleName

The IAM role that Temporal Cloud assumes for writing records to the customer's S3 bucket.

public string RoleName { get; set; }

Property Value

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 S3Spec Clone()

Returns

S3Spec

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

bool

true if the specified object is equal to the current object; otherwise, false.

Equals(S3Spec)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(S3Spec other)

Parameters

other S3Spec

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

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(S3Spec)

Merges the given message into this one.

public void MergeFrom(S3Spec other)

Parameters

other S3Spec

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 CodedOutputStream

Coded output stream to write the data to. Must not be null.