Represents an AwsS3Data.
Package
@google-cloud/storage-transferConstructors
(constructor)(properties)
constructor(properties?: google.storagetransfer.v1.IAwsS3Data);Constructs a new AwsS3Data.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAwsS3Data
Properties to set |
Properties
awsAccessKey
public awsAccessKey?: (google.storagetransfer.v1.IAwsAccessKey|null);AwsS3Data awsAccessKey.
bucketName
public bucketName: string;AwsS3Data bucketName.
credentialsSecret
public credentialsSecret: string;AwsS3Data credentialsSecret.
path
public path: string;AwsS3Data path.
roleArn
public roleArn: string;AwsS3Data roleArn.
Methods
create(properties)
public static create(properties?: google.storagetransfer.v1.IAwsS3Data): google.storagetransfer.v1.AwsS3Data;Creates a new AwsS3Data instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAwsS3Data
Properties to set |
| Returns | |
|---|---|
| Type | Description |
AwsS3Data | AwsS3Data instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.storagetransfer.v1.AwsS3Data;Decodes an AwsS3Data message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
AwsS3Data | AwsS3Data |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.storagetransfer.v1.AwsS3Data;Decodes an AwsS3Data message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
AwsS3Data | AwsS3Data |
encode(message, writer)
public static encode(message: google.storagetransfer.v1.IAwsS3Data, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AwsS3Data message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAwsS3Data
AwsS3Data message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.storagetransfer.v1.IAwsS3Data, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AwsS3Data message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAwsS3Data
AwsS3Data message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.storagetransfer.v1.AwsS3Data;Creates an AwsS3Data message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
AwsS3Data | AwsS3Data |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for AwsS3Data
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this AwsS3Data to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.storagetransfer.v1.AwsS3Data, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an AwsS3Data message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
AwsS3Data
AwsS3Data |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an AwsS3Data message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|