BareMetal API, REST: PublicSubnet.Update

Field

Description

publicSubnetId

string

Required field. ID of the PublicSubnet resource to update.

To get the public subnet ID, use a PublicSubnetService.List request.

Field

Description

updateMask

string (field-mask)

A comma-separated names off ALL fields to be updated.
Only the specified fields will be changed. The others will be left untouched.
If the field is specified in updateMask and no value for that field was sent in the request,
the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated.
Fields specified in the request will be updated to provided values.
The rest of the fields will be reset to the default.

name

string

Name of the public subnet.
The name must be unique within the folder.

description

string

Description of the public subnet.

hardwarePoolIds[]

string

IDs of the hardware pool that the public subnet belongs to.

To get a list of available hardware pools, use the HardwarePoolService.List request.

type

enum (PublicSubnetType)

• PUBLIC_SUBNET_TYPE_UNSPECIFIED: Unspecified public subnet type.
• DEDICATED: Dedicated public subnet.
• EPHEMERAL: Ephemeral public subnet.

labels

object (map<string, string>)

Resource labels as key:value pairs.

Existing set of labels is completely replaced by the provided set.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdatePublicSubnetMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

PublicSubnet

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

publicSubnetId

string

ID of the PublicSubnet resource that is being updated.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

Field

Description

id

string

ID of the public subnet.

cloudId

string

ID of the cloud that the public subnet belongs to.

folderId

string

ID of the folder that the public subnet belongs to.

name

string

Name of the public subnet.
The name is unique within the folder.

description

string

Optional description of the public subnet.

zoneId

string

ID of the availability zone where the server resides.

hardwarePoolIds[]

string

IDs of the hardware pool that the public subnet belongs to.

type

enum (PublicSubnetType)

Type of the public subnet (static or ephemeral).

• PUBLIC_SUBNET_TYPE_UNSPECIFIED: Unspecified public subnet type.
• DEDICATED: Dedicated public subnet.
• EPHEMERAL: Ephemeral public subnet.

prefixLength

string (int64)

Prefix length of the public subnet CIDR block.

cidr

string

CIDR block for the public subnet.

dhcpOptions

DhcpOptions

DHCP options for the public subnet.

gatewayIp

string

Gateway IP address for the public subnet.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

labels

object (map<string, string>)

Resource labels as key:value pairs.

Field

Description

startIp

string

Start IP address of the DHCP range (inclusive).

endIp

string

End IP address of the DHCP range (inclusive).