Represents a StorageLayout.
Package
@google-cloud/storage-controlConstructors
(constructor)(properties)
constructor(properties?: google.storage.control.v2.IStorageLayout);
Constructs a new StorageLayout.
Parameter | |
---|---|
Name | Description |
properties |
IStorageLayout
Properties to set |
Properties
customPlacementConfig
public customPlacementConfig?: (google.storage.control.v2.StorageLayout.ICustomPlacementConfig|null);
StorageLayout customPlacementConfig.
hierarchicalNamespace
public hierarchicalNamespace?: (google.storage.control.v2.StorageLayout.IHierarchicalNamespace|null);
StorageLayout hierarchicalNamespace.
location
public location: string;
StorageLayout location.
locationType
public locationType: string;
StorageLayout locationType.
name
public name: string;
StorageLayout name.
Methods
create(properties)
public static create(properties?: google.storage.control.v2.IStorageLayout): google.storage.control.v2.StorageLayout;
Creates a new StorageLayout instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IStorageLayout
Properties to set |
Returns | |
---|---|
Type | Description |
StorageLayout |
StorageLayout instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.storage.control.v2.StorageLayout;
Decodes a StorageLayout 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 |
StorageLayout |
StorageLayout |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.storage.control.v2.StorageLayout;
Decodes a StorageLayout message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
StorageLayout |
StorageLayout |
encode(message, writer)
public static encode(message: google.storage.control.v2.IStorageLayout, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified StorageLayout message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IStorageLayout
StorageLayout 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.storage.control.v2.IStorageLayout, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified StorageLayout message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IStorageLayout
StorageLayout 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.storage.control.v2.StorageLayout;
Creates a StorageLayout 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 |
StorageLayout |
StorageLayout |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for StorageLayout
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 StorageLayout to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.storage.control.v2.StorageLayout, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a StorageLayout message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
StorageLayout
StorageLayout |
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 a StorageLayout message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|