close()

Close httplib2 connections.

detachLun(instance, body=None, x__xgafv=None)

Detach LUN from Instance.

Args:
instance: string, Required. Name of the instance. (required)
body: object, The request body.
The object takes the form of:

{ # Message for detach specific LUN from an Instance.
"lun": "A String", # Required. Name of the Lun to detach.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # 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 standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Get details about a single server.

Args:
  name: string, Required. Name of the resource. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A server.
  "createTime": "A String", # Output only. Create a time stamp.
  "hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false.
  "id": "A String", # An identifier for the `Instance`, generated by the backend.
  "interactiveSerialConsoleEnabled": True or False, # True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.
  "labels": { # Labels as key value pairs.
    "a_key": "A String",
  },
  "logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled.
    { # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface.
      "interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated.
      "logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface.
        { # Each logical network interface is effectively a network and IP pair.
          "defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
          "id": "A String", # An identifier for the `Network`, generated by the backend.
          "ipAddress": "A String", # IP address in the network
          "network": "A String", # Name of the network
          "networkType": "A String", # Type of network.
        },
      ],
      "name": "A String", # Interface name. This is of syntax or and forms part of the network template name.
    },
  ],
  "luns": [ # List of LUNs associated with this server.
    { # A storage volume logical unit number (LUN).
      "bootLun": True or False, # Display if this LUN is a boot LUN.
      "id": "A String", # An identifier for the LUN, generated by the backend.
      "multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.
      "name": "A String", # Output only. The name of the LUN.
      "shareable": True or False, # Display if this LUN can be shared between multiple physical servers.
      "sizeGb": "A String", # The size of this LUN, in gigabytes.
      "state": "A String", # The state of this storage volume.
      "storageType": "A String", # The storage type for this LUN.
      "storageVolume": "A String", # Display the storage volume for this LUN.
      "wwid": "A String", # The WWID for this LUN.
    },
  ],
  "machineType": "A String", # The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
  "name": "A String", # Output only. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}`
  "networkTemplate": "A String", # Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic".
  "networks": [ # List of networks associated with this server.
    { # A Network.
      "cidr": "A String", # The cidr of the Network.
      "id": "A String", # An identifier for the `Network`, generated by the backend.
      "ipAddress": "A String", # IP address configured.
      "labels": { # Labels as key value pairs.
        "a_key": "A String",
      },
      "macAddress": [ # List of physical interfaces.
        "A String",
      ],
      "name": "A String", # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}`
      "reservations": [ # List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.
        { # A reservation of one or more addresses in a network.
          "endAddress": "A String", # The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
          "note": "A String", # A note about this reservation, intended for human consumption.
          "startAddress": "A String", # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
        },
      ],
      "servicesCidr": "A String", # IP range for reserved for services (e.g. NFS).
      "state": "A String", # The Network state.
      "type": "A String", # The type of this network.
      "vlanId": "A String", # The vlan id of the Network.
      "vrf": { # A network VRF. # The vrf for the Network.
        "name": "A String", # The name of the VRF.
        "qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VRF.
          "bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps.
        },
        "state": "A String", # The possible state of VRF.
        "vlanAttachments": [ # The list of VLAN attachments for the VRF.
          { # VLAN attachment details.
            "peerIp": "A String", # The peer IP of the attachment.
            "peerVlanId": "A String", # The peer vlan ID of the attachment.
            "routerIp": "A String", # The router IP of the attachment.
          },
        ],
      },
    },
  ],
  "osImage": "A String", # The OS image currently installed on the server.
  "pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only.
  "state": "A String", # The state of the server.
  "updateTime": "A String", # Output only. Update a time stamp.
}

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

List servers in a given project and location.

Args:
  parent: string, Required. Parent value for ListInstancesRequest. (required)
  filter: string, List filter.
  pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  pageToken: string, A token identifying a page of results from the server.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the list of servers.
  "instances": [ # The list of servers.
    { # A server.
      "createTime": "A String", # Output only. Create a time stamp.
      "hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false.
      "id": "A String", # An identifier for the `Instance`, generated by the backend.
      "interactiveSerialConsoleEnabled": True or False, # True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.
      "labels": { # Labels as key value pairs.
        "a_key": "A String",
      },
      "logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled.
        { # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface.
          "interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated.
          "logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface.
            { # Each logical network interface is effectively a network and IP pair.
              "defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
              "id": "A String", # An identifier for the `Network`, generated by the backend.
              "ipAddress": "A String", # IP address in the network
              "network": "A String", # Name of the network
              "networkType": "A String", # Type of network.
            },
          ],
          "name": "A String", # Interface name. This is of syntax or and forms part of the network template name.
        },
      ],
      "luns": [ # List of LUNs associated with this server.
        { # A storage volume logical unit number (LUN).
          "bootLun": True or False, # Display if this LUN is a boot LUN.
          "id": "A String", # An identifier for the LUN, generated by the backend.
          "multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.
          "name": "A String", # Output only. The name of the LUN.
          "shareable": True or False, # Display if this LUN can be shared between multiple physical servers.
          "sizeGb": "A String", # The size of this LUN, in gigabytes.
          "state": "A String", # The state of this storage volume.
          "storageType": "A String", # The storage type for this LUN.
          "storageVolume": "A String", # Display the storage volume for this LUN.
          "wwid": "A String", # The WWID for this LUN.
        },
      ],
      "machineType": "A String", # The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
      "name": "A String", # Output only. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}`
      "networkTemplate": "A String", # Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic".
      "networks": [ # List of networks associated with this server.
        { # A Network.
          "cidr": "A String", # The cidr of the Network.
          "id": "A String", # An identifier for the `Network`, generated by the backend.
          "ipAddress": "A String", # IP address configured.
          "labels": { # Labels as key value pairs.
            "a_key": "A String",
          },
          "macAddress": [ # List of physical interfaces.
            "A String",
          ],
          "name": "A String", # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}`
          "reservations": [ # List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.
            { # A reservation of one or more addresses in a network.
              "endAddress": "A String", # The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
              "note": "A String", # A note about this reservation, intended for human consumption.
              "startAddress": "A String", # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
            },
          ],
          "servicesCidr": "A String", # IP range for reserved for services (e.g. NFS).
          "state": "A String", # The Network state.
          "type": "A String", # The type of this network.
          "vlanId": "A String", # The vlan id of the Network.
          "vrf": { # A network VRF. # The vrf for the Network.
            "name": "A String", # The name of the VRF.
            "qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VRF.
              "bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps.
            },
            "state": "A String", # The possible state of VRF.
            "vlanAttachments": [ # The list of VLAN attachments for the VRF.
              { # VLAN attachment details.
                "peerIp": "A String", # The peer IP of the attachment.
                "peerVlanId": "A String", # The peer vlan ID of the attachment.
                "routerIp": "A String", # The router IP of the attachment.
              },
            ],
          },
        },
      ],
      "osImage": "A String", # The OS image currently installed on the server.
      "pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only.
      "state": "A String", # The state of the server.
      "updateTime": "A String", # Output only. Update a time stamp.
    },
  ],
  "nextPageToken": "A String", # A token identifying a page of results from the server.
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Update details of a single server.

Args:
  name: string, Output only. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A server.
  "createTime": "A String", # Output only. Create a time stamp.
  "hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false.
  "id": "A String", # An identifier for the `Instance`, generated by the backend.
  "interactiveSerialConsoleEnabled": True or False, # True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.
  "labels": { # Labels as key value pairs.
    "a_key": "A String",
  },
  "logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled.
    { # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface.
      "interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated.
      "logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface.
        { # Each logical network interface is effectively a network and IP pair.
          "defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
          "id": "A String", # An identifier for the `Network`, generated by the backend.
          "ipAddress": "A String", # IP address in the network
          "network": "A String", # Name of the network
          "networkType": "A String", # Type of network.
        },
      ],
      "name": "A String", # Interface name. This is of syntax or and forms part of the network template name.
    },
  ],
  "luns": [ # List of LUNs associated with this server.
    { # A storage volume logical unit number (LUN).
      "bootLun": True or False, # Display if this LUN is a boot LUN.
      "id": "A String", # An identifier for the LUN, generated by the backend.
      "multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.
      "name": "A String", # Output only. The name of the LUN.
      "shareable": True or False, # Display if this LUN can be shared between multiple physical servers.
      "sizeGb": "A String", # The size of this LUN, in gigabytes.
      "state": "A String", # The state of this storage volume.
      "storageType": "A String", # The storage type for this LUN.
      "storageVolume": "A String", # Display the storage volume for this LUN.
      "wwid": "A String", # The WWID for this LUN.
    },
  ],
  "machineType": "A String", # The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
  "name": "A String", # Output only. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}`
  "networkTemplate": "A String", # Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic".
  "networks": [ # List of networks associated with this server.
    { # A Network.
      "cidr": "A String", # The cidr of the Network.
      "id": "A String", # An identifier for the `Network`, generated by the backend.
      "ipAddress": "A String", # IP address configured.
      "labels": { # Labels as key value pairs.
        "a_key": "A String",
      },
      "macAddress": [ # List of physical interfaces.
        "A String",
      ],
      "name": "A String", # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}`
      "reservations": [ # List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.
        { # A reservation of one or more addresses in a network.
          "endAddress": "A String", # The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
          "note": "A String", # A note about this reservation, intended for human consumption.
          "startAddress": "A String", # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
        },
      ],
      "servicesCidr": "A String", # IP range for reserved for services (e.g. NFS).
      "state": "A String", # The Network state.
      "type": "A String", # The type of this network.
      "vlanId": "A String", # The vlan id of the Network.
      "vrf": { # A network VRF. # The vrf for the Network.
        "name": "A String", # The name of the VRF.
        "qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VRF.
          "bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps.
        },
        "state": "A String", # The possible state of VRF.
        "vlanAttachments": [ # The list of VLAN attachments for the VRF.
          { # VLAN attachment details.
            "peerIp": "A String", # The peer IP of the attachment.
            "peerVlanId": "A String", # The peer vlan ID of the attachment.
            "routerIp": "A String", # The router IP of the attachment.
          },
        ],
      },
    },
  ],
  "osImage": "A String", # The OS image currently installed on the server.
  "pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only.
  "state": "A String", # The state of the server.
  "updateTime": "A String", # Output only. Update a time stamp.
}

  updateMask: string, The list of fields to update. The currently supported fields are: `labels` `hyperthreading_enabled` `os_image`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # 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.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # 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 standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

reset(name, body=None, x__xgafv=None)

Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.

Args:
name: string, Required. Name of the resource. (required)
body: object, The request body.
The object takes the form of:

{ # Message requesting to reset a server.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # 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 standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

start(name, body=None, x__xgafv=None)

Starts a server that was shutdown.

Args:
name: string, Required. Name of the resource. (required)
body: object, The request body.
The object takes the form of:

{ # Message requesting to start a server.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # 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 standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

stop(name, body=None, x__xgafv=None)

Stop a running server.

Args:
name: string, Required. Name of the resource. (required)
body: object, The request body.
The object takes the form of:

{ # Message requesting to stop a server.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # 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 standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

Bare Metal Solution API . projects . locations . instances

Instance Methods

Method Details