Patch
|
|||||
|
|
Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and manage your Google Compute Engine resources
Input
This building block consumes 22 input parameters
Name | Format | Description |
---|---|---|
project Required |
STRING |
Project ID for this request |
network Required |
STRING |
Name of the network to update |
requestId |
STRING |
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000) |
IPv4Range |
STRING |
Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created |
autoCreateSubnetworks |
BOOLEAN |
When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges |
creationTimestamp |
STRING |
[Output Only] Creation timestamp in RFC3339 text format |
description |
STRING |
An optional description of this resource. Provide this field when you create the resource |
gatewayIPv4 |
STRING |
[Output Only] The gateway address for default routing out of the network, selected by GCP |
id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
kind |
STRING |
[Output Only] Type of the resource. Always compute#network for networks |
name |
STRING |
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `a-z?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit |
peerings[] |
OBJECT |
A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering |
peerings[].autoCreateRoutes |
BOOLEAN |
This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE |
peerings[].exchangeSubnetRoutes |
BOOLEAN |
Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE |
peerings[].name |
STRING |
Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression |
peerings[].network |
STRING |
The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network |
peerings[].state |
ENUMERATION |
[Output Only] State for the peering, either |
peerings[].stateDetails |
STRING |
[Output Only] Details about the current state of the peering |
routingConfig |
OBJECT |
A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide |
routingConfig.routingMode |
ENUMERATION |
The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions |
selfLink |
STRING |
[Output Only] Server-defined URL for the resource |
subnetworks[] |
STRING |
= Parameter name
= Format
project STRING Required Project ID for this request |
network STRING Required Name of the network to update |
requestId STRING An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000) |
IPv4Range STRING Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created |
autoCreateSubnetworks BOOLEAN When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges |
creationTimestamp STRING [Output Only] Creation timestamp in RFC3339 text format |
description STRING An optional description of this resource. Provide this field when you create the resource |
gatewayIPv4 STRING [Output Only] The gateway address for default routing out of the network, selected by GCP |
id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
kind STRING [Output Only] Type of the resource. Always compute#network for networks |
name STRING Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `a-z?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit |
peerings[] OBJECT A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering |
peerings[].autoCreateRoutes BOOLEAN This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE |
peerings[].exchangeSubnetRoutes BOOLEAN Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE |
peerings[].name STRING Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression |
peerings[].network STRING The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network |
peerings[].state ENUMERATION [Output Only] State for the peering, either |
peerings[].stateDetails STRING [Output Only] Details about the current state of the peering |
routingConfig OBJECT A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide |
routingConfig.routingMode ENUMERATION The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions |
selfLink STRING [Output Only] Server-defined URL for the resource |
subnetworks[] STRING |
Output
This building block provides 32 output parameters
Name | Format | Description |
---|---|---|
clientOperationId |
STRING |
[Output Only] The value of |
creationTimestamp |
STRING |
[Deprecated] This field is deprecated |
description |
STRING |
[Output Only] A textual description of the operation, which is set when the operation is created |
endTime |
STRING |
[Output Only] The time that this operation was completed. This value is in RFC3339 text format |
error |
OBJECT |
[Output Only] If errors are generated during processing of the operation, this field will be populated |
error.errors[] |
OBJECT |
|
error.errors[].code |
STRING |
[Output Only] The error type identifier for this error |
error.errors[].location |
STRING |
[Output Only] Indicates the field in the request that caused the error. This property is optional |
error.errors[].message |
STRING |
[Output Only] An optional, human-readable error message |
httpErrorMessage |
STRING |
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND |
httpErrorStatusCode |
INTEGER |
[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found |
id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
insertTime |
STRING |
[Output Only] The time that this operation was requested. This value is in RFC3339 text format |
kind |
STRING |
[Output Only] Type of the resource. Always compute#operation for Operation resources |
name |
STRING |
[Output Only] Name of the resource |
operationType |
STRING |
[Output Only] The type of operation, such as insert, update, or delete, and so on |
progress |
INTEGER |
[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses |
region |
STRING |
[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations |
selfLink |
STRING |
[Output Only] Server-defined URL for the resource |
startTime |
STRING |
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format |
status |
ENUMERATION |
[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE |
statusMessage |
STRING |
[Output Only] An optional textual description of the current status of the operation |
targetId |
INTEGER |
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource |
targetLink |
STRING |
[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from |
user |
STRING |
[Output Only] User who requested the operation, for example: [email protected] |
warnings[] |
OBJECT |
|
warnings[].code |
ENUMERATION |
[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warnings[].data[] |
OBJECT |
|
warnings[].data[].key |
STRING |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding) |
warnings[].data[].value |
STRING |
[Output Only] A warning data value corresponding to the key |
warnings[].message |
STRING |
[Output Only] A human-readable description of the warning code |
zone |
STRING |
[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations |
= Parameter name
= Format
clientOperationId STRING [Output Only] The value of |
creationTimestamp STRING [Deprecated] This field is deprecated |
description STRING [Output Only] A textual description of the operation, which is set when the operation is created |
endTime STRING [Output Only] The time that this operation was completed. This value is in RFC3339 text format |
error OBJECT [Output Only] If errors are generated during processing of the operation, this field will be populated |
error.errors[] OBJECT |
error.errors[].code STRING [Output Only] The error type identifier for this error |
error.errors[].location STRING [Output Only] Indicates the field in the request that caused the error. This property is optional |
error.errors[].message STRING [Output Only] An optional, human-readable error message |
httpErrorMessage STRING [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND |
httpErrorStatusCode INTEGER [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found |
id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
insertTime STRING [Output Only] The time that this operation was requested. This value is in RFC3339 text format |
kind STRING [Output Only] Type of the resource. Always compute#operation for Operation resources |
name STRING [Output Only] Name of the resource |
operationType STRING [Output Only] The type of operation, such as insert, update, or delete, and so on |
progress INTEGER [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses |
region STRING [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations |
selfLink STRING [Output Only] Server-defined URL for the resource |
startTime STRING [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format |
status ENUMERATION [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE |
statusMessage STRING [Output Only] An optional textual description of the current status of the operation |
targetId INTEGER [Output Only] The unique target ID, which identifies a specific incarnation of the target resource |
targetLink STRING [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from |
user STRING [Output Only] User who requested the operation, for example: [email protected] |
warnings[] OBJECT |
warnings[].code ENUMERATION [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response |
warnings[].data[] OBJECT |
warnings[].data[].key STRING [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding) |
warnings[].data[].value STRING [Output Only] A warning data value corresponding to the key |
warnings[].message STRING [Output Only] A human-readable description of the warning code |
zone STRING [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations |