Class protos.google.cloud.batch.v1.GCS (1.4.0)
Represents a GCS.
Package
@google-cloud/batchConstructors
(constructor)(properties)
constructor(properties?:google.cloud.batch.v1.IGCS);Constructs a new GCS.
| Parameter | |
|---|---|
| Name | Description |
properties | IGCSProperties to set |
Properties
remotePath
publicremotePath:string;GCS remotePath.
Methods
create(properties)
publicstaticcreate(properties?:google.cloud.batch.v1.IGCS):google.cloud.batch.v1.GCS;Creates a new GCS instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IGCSProperties to set |
| Returns | |
|---|---|
| Type | Description |
GCS | GCS instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.cloud.batch.v1.GCS;Decodes a GCS message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
GCS | GCS |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.cloud.batch.v1.GCS;Decodes a GCS message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
GCS | GCS |
encode(message, writer)
publicstaticencode(message:google.cloud.batch.v1.IGCS,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified GCS message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IGCSGCS message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.cloud.batch.v1.IGCS,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified GCS message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IGCSGCS message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(object:{[k:string]:any}):google.cloud.batch.v1.GCS;Creates a GCS 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 |
GCS | GCS |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for GCS
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this GCS to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(message:google.cloud.batch.v1.GCS,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from a GCS message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message | GCSGCS |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a GCS message.
| Parameter | |
|---|---|
| Name | Description |
message | { [k: string]: any }Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.