close()

Close httplib2 connections.

create(parent, body=None, requestId=None, serverId=None, x__xgafv=None)

Creates a new Server in a given project and location.

Args:
parent: string, Required. Value for parent. (required)
body: object, The request body.
The object takes the form of:

{ # Message describing Server object
"accessType": "A String", # Required. The access type of the Server.
"createTime": "A String", # Output only. [Output only] Create time stamp
"displayName": "A String", # Optional. Display name of the Server
"externalConfig": { # Configuration for external server. # Configuration for external access.
"allowedCidrBlocks": [ # Optional. List of CIDR blocks that are allowed to access the Server. A CIDR range consists of an IP Address and a prefix length to construct the subnet mask. By default, the prefix length is 32 (i.e. matches a single IP address). For now, only IPV4 addresses are supported. Examples: "203.0.113.0/24" - matches with the IP addresses in the range 203.0.113.0 - 203.0.113.255. "0.0.0.0/0" - matches against any IP address. This field must contain at least one entry if the access type is EXTERNAL. The number of allowed CIDR blocks cannot exceed 500. Example: 192.168.0.0/16
"A String",
],
"ipAddress": "A String", # Output only. IP address of the LB via which clients will connect.
},
"googleManagedServerCredential": { # Represents credentials of an FTP Server. # Output only. Credentials of the FTP Server.
"asymmetricAlgorithm": "A String", # Output only. Asymmetric algorithm used by the public key. Possible values (can be expanded in future): - ssh-ed25519
"fingerprint": "A String", # Output only. The fingerprint is a hash of the public key, and is displayed when clients access the server for the first time to verify the server's identity.
},
"internalConfig": { # Configuration for private server accessible via PSC. # Configuration for internal access.
"consumerAcceptList": [ # Required. A list of projects that are permitted to connect. At least one project is required in the allow list.
{ # A consumer project or network that is permitted to connect to the server via PSC.
"connectionLimit": "A String", # Required. The connection limit for the consumer. Value must be greater than 0.
"project": "A String", # The project ID or number of the consumer project. Must be in the format: `projects/{project}`.
},
],
"consumerRejectList": [ # Optional. A list of projects that are denied connection. Format: "projects/sample_project_id" or "projects/1234567890" Projects in this list will be denied access, even if they are included in the `allow_list`. If this list is empty, no projects are explicitly rejected.
{ # A consumer project or network that is denied to connect to the server via PSC.
"project": "A String", # The project ID or number of the consumer project. Must be in the format: `projects/{project}`.
},
],
"pscEndpoints": [ # Output only. Details of endpoints created by the customer.
{ # Details of PSC endpoint created by customer.
"endpoint": "A String", # Output only. This is a Resource name for Private Service Connect endpoint. Format: `projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}`
"network": "A String", # Output only. The consumer network. Format: `projects/{project}/locations/{location}/networks/{network}`
"status": "A String", # Output only. The status of the connected endpoint.
},
],
"serviceAttachment": "A String", # Output only. The resource name of the service attachment. Format: `projects/{project}/regions/{region}/serviceAttachments/{service_attachment}`
},
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # Identifier. name of resource
"serviceAgent": "A String", # Output only. Service agent used to access the customer bucket.
"state": "A String", # Output only. The state of the server.
"updateTime": "A String", # Output only. [Output only] Update time stamp
}

requestId: string, Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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).
serverId: string, Required. A unique ID for the server. Must start with a lowercase letter, and end with a lowercase letter or number. Can contain lowercase letters, numbers, and hyphens. Maximum length is 30 characters.
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, successful response of the operation. 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.
},
}

delete(name, x__xgafv=None)

Deletes 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:

{ # 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, successful response of the operation. 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, view=None, x__xgafv=None)

Gets details of a single Server.

Args:
  name: string, Required. Name of the resource (required)
  view: string, Optional. The view of the Server resource to return.
    Allowed values
      SERVER_VIEW_UNSPECIFIED - Default value. Equivalent to SERVER_VIEW_BASIC.
      SERVER_VIEW_BASIC - Basic view. Excludes heavy configurations (internal_config, external_config, google_managed_server_credential).
      SERVER_VIEW_FULL - Full view. Includes all fields.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message describing Server object
  "accessType": "A String", # Required. The access type of the Server.
  "createTime": "A String", # Output only. [Output only] Create time stamp
  "displayName": "A String", # Optional. Display name of the Server
  "externalConfig": { # Configuration for external server. # Configuration for external access.
    "allowedCidrBlocks": [ # Optional. List of CIDR blocks that are allowed to access the Server. A CIDR range consists of an IP Address and a prefix length to construct the subnet mask. By default, the prefix length is 32 (i.e. matches a single IP address). For now, only IPV4 addresses are supported. Examples: "203.0.113.0/24" - matches with the IP addresses in the range 203.0.113.0 - 203.0.113.255. "0.0.0.0/0" - matches against any IP address. This field must contain at least one entry if the access type is EXTERNAL. The number of allowed CIDR blocks cannot exceed 500. Example: 192.168.0.0/16
      "A String",
    ],
    "ipAddress": "A String", # Output only. IP address of the LB via which clients will connect.
  },
  "googleManagedServerCredential": { # Represents credentials of an FTP Server. # Output only. Credentials of the FTP Server.
    "asymmetricAlgorithm": "A String", # Output only. Asymmetric algorithm used by the public key. Possible values (can be expanded in future): - ssh-ed25519
    "fingerprint": "A String", # Output only. The fingerprint is a hash of the public key, and is displayed when clients access the server for the first time to verify the server's identity.
  },
  "internalConfig": { # Configuration for private server accessible via PSC. # Configuration for internal access.
    "consumerAcceptList": [ # Required. A list of projects that are permitted to connect. At least one project is required in the allow list.
      { # A consumer project or network that is permitted to connect to the server via PSC.
        "connectionLimit": "A String", # Required. The connection limit for the consumer. Value must be greater than 0.
        "project": "A String", # The project ID or number of the consumer project. Must be in the format: `projects/{project}`.
      },
    ],
    "consumerRejectList": [ # Optional. A list of projects that are denied connection. Format: "projects/sample_project_id" or "projects/1234567890" Projects in this list will be denied access, even if they are included in the `allow_list`. If this list is empty, no projects are explicitly rejected.
      { # A consumer project or network that is denied to connect to the server via PSC.
        "project": "A String", # The project ID or number of the consumer project. Must be in the format: `projects/{project}`.
      },
    ],
    "pscEndpoints": [ # Output only. Details of endpoints created by the customer.
      { # Details of PSC endpoint created by customer.
        "endpoint": "A String", # Output only. This is a Resource name for Private Service Connect endpoint. Format: `projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}`
        "network": "A String", # Output only. The consumer network. Format: `projects/{project}/locations/{location}/networks/{network}`
        "status": "A String", # Output only. The status of the connected endpoint.
      },
    ],
    "serviceAttachment": "A String", # Output only. The resource name of the service attachment. Format: `projects/{project}/regions/{region}/serviceAttachments/{service_attachment}`
  },
  "labels": { # Optional. Labels as key value pairs
    "a_key": "A String",
  },
  "name": "A String", # Identifier. name of resource
  "serviceAgent": "A String", # Output only. Service agent used to access the customer bucket.
  "state": "A String", # Output only. The state of the server.
  "updateTime": "A String", # Output only. [Output only] Update time stamp
}

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

Lists Servers in a given project and location.

Args:
  parent: string, Required. Parent value for ListServersRequest (required)
  filter: string, Optional. Filtering results
  orderBy: string, Optional. Hint for how to order the results
  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, Optional. A token identifying a page of results the server should return.
  view: string, Optional. The view of the Server resource to return.
    Allowed values
      SERVER_VIEW_UNSPECIFIED - Default value. Equivalent to SERVER_VIEW_BASIC.
      SERVER_VIEW_BASIC - Basic view. Excludes heavy configurations (internal_config, external_config, google_managed_server_credential).
      SERVER_VIEW_FULL - Full view. Includes all fields.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to listing Servers
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
  "servers": [ # The list of Server
    { # Message describing Server object
      "accessType": "A String", # Required. The access type of the Server.
      "createTime": "A String", # Output only. [Output only] Create time stamp
      "displayName": "A String", # Optional. Display name of the Server
      "externalConfig": { # Configuration for external server. # Configuration for external access.
        "allowedCidrBlocks": [ # Optional. List of CIDR blocks that are allowed to access the Server. A CIDR range consists of an IP Address and a prefix length to construct the subnet mask. By default, the prefix length is 32 (i.e. matches a single IP address). For now, only IPV4 addresses are supported. Examples: "203.0.113.0/24" - matches with the IP addresses in the range 203.0.113.0 - 203.0.113.255. "0.0.0.0/0" - matches against any IP address. This field must contain at least one entry if the access type is EXTERNAL. The number of allowed CIDR blocks cannot exceed 500. Example: 192.168.0.0/16
          "A String",
        ],
        "ipAddress": "A String", # Output only. IP address of the LB via which clients will connect.
      },
      "googleManagedServerCredential": { # Represents credentials of an FTP Server. # Output only. Credentials of the FTP Server.
        "asymmetricAlgorithm": "A String", # Output only. Asymmetric algorithm used by the public key. Possible values (can be expanded in future): - ssh-ed25519
        "fingerprint": "A String", # Output only. The fingerprint is a hash of the public key, and is displayed when clients access the server for the first time to verify the server's identity.
      },
      "internalConfig": { # Configuration for private server accessible via PSC. # Configuration for internal access.
        "consumerAcceptList": [ # Required. A list of projects that are permitted to connect. At least one project is required in the allow list.
          { # A consumer project or network that is permitted to connect to the server via PSC.
            "connectionLimit": "A String", # Required. The connection limit for the consumer. Value must be greater than 0.
            "project": "A String", # The project ID or number of the consumer project. Must be in the format: `projects/{project}`.
          },
        ],
        "consumerRejectList": [ # Optional. A list of projects that are denied connection. Format: "projects/sample_project_id" or "projects/1234567890" Projects in this list will be denied access, even if they are included in the `allow_list`. If this list is empty, no projects are explicitly rejected.
          { # A consumer project or network that is denied to connect to the server via PSC.
            "project": "A String", # The project ID or number of the consumer project. Must be in the format: `projects/{project}`.
          },
        ],
        "pscEndpoints": [ # Output only. Details of endpoints created by the customer.
          { # Details of PSC endpoint created by customer.
            "endpoint": "A String", # Output only. This is a Resource name for Private Service Connect endpoint. Format: `projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}`
            "network": "A String", # Output only. The consumer network. Format: `projects/{project}/locations/{location}/networks/{network}`
            "status": "A String", # Output only. The status of the connected endpoint.
          },
        ],
        "serviceAttachment": "A String", # Output only. The resource name of the service attachment. Format: `projects/{project}/regions/{region}/serviceAttachments/{service_attachment}`
      },
      "labels": { # Optional. Labels as key value pairs
        "a_key": "A String",
      },
      "name": "A String", # Identifier. name of resource
      "serviceAgent": "A String", # Output only. Service agent used to access the customer bucket.
      "state": "A String", # Output only. The state of the server.
      "updateTime": "A String", # Output only. [Output only] Update time stamp
    },
  ],
  "unreachable": [ # Unordered list. 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, requestId=None, updateMask=None, x__xgafv=None)

Updates the parameters of a single Server.

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

{ # Message describing Server object
"accessType": "A String", # Required. The access type of the Server.
"createTime": "A String", # Output only. [Output only] Create time stamp
"displayName": "A String", # Optional. Display name of the Server
"externalConfig": { # Configuration for external server. # Configuration for external access.
"allowedCidrBlocks": [ # Optional. List of CIDR blocks that are allowed to access the Server. A CIDR range consists of an IP Address and a prefix length to construct the subnet mask. By default, the prefix length is 32 (i.e. matches a single IP address). For now, only IPV4 addresses are supported. Examples: "203.0.113.0/24" - matches with the IP addresses in the range 203.0.113.0 - 203.0.113.255. "0.0.0.0/0" - matches against any IP address. This field must contain at least one entry if the access type is EXTERNAL. The number of allowed CIDR blocks cannot exceed 500. Example: 192.168.0.0/16
"A String",
],
"ipAddress": "A String", # Output only. IP address of the LB via which clients will connect.
},
"googleManagedServerCredential": { # Represents credentials of an FTP Server. # Output only. Credentials of the FTP Server.
"asymmetricAlgorithm": "A String", # Output only. Asymmetric algorithm used by the public key. Possible values (can be expanded in future): - ssh-ed25519
"fingerprint": "A String", # Output only. The fingerprint is a hash of the public key, and is displayed when clients access the server for the first time to verify the server's identity.
},
"internalConfig": { # Configuration for private server accessible via PSC. # Configuration for internal access.
"consumerAcceptList": [ # Required. A list of projects that are permitted to connect. At least one project is required in the allow list.
{ # A consumer project or network that is permitted to connect to the server via PSC.
"connectionLimit": "A String", # Required. The connection limit for the consumer. Value must be greater than 0.
"project": "A String", # The project ID or number of the consumer project. Must be in the format: `projects/{project}`.
},
],
"consumerRejectList": [ # Optional. A list of projects that are denied connection. Format: "projects/sample_project_id" or "projects/1234567890" Projects in this list will be denied access, even if they are included in the `allow_list`. If this list is empty, no projects are explicitly rejected.
{ # A consumer project or network that is denied to connect to the server via PSC.
"project": "A String", # The project ID or number of the consumer project. Must be in the format: `projects/{project}`.
},
],
"pscEndpoints": [ # Output only. Details of endpoints created by the customer.
{ # Details of PSC endpoint created by customer.
"endpoint": "A String", # Output only. This is a Resource name for Private Service Connect endpoint. Format: `projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}`
"network": "A String", # Output only. The consumer network. Format: `projects/{project}/locations/{location}/networks/{network}`
"status": "A String", # Output only. The status of the connected endpoint.
},
],
"serviceAttachment": "A String", # Output only. The resource name of the service attachment. Format: `projects/{project}/regions/{region}/serviceAttachments/{service_attachment}`
},
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # Identifier. name of resource
"serviceAgent": "A String", # Output only. Service agent used to access the customer bucket.
"state": "A String", # Output only. The state of the server.
"updateTime": "A String", # Output only. [Output only] Update time stamp
}

requestId: string, Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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).
updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Server resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
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, successful response of the operation. 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 stopping/stopped Server.

Args:
name: string, Required. Name of the resource Format: `projects/{project}/locations/{location}/servers/{server}` (required)
body: object, The request body.
The object takes the form of:

{ # Request message for starting 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, successful response of the operation. 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)

Stops an active Server.

Args:
name: string, Required. Name of the resource. Format: `projects/{project}/locations/{location}/servers/{server}` (required)
body: object, The request body.
The object takes the form of:

{ # Request message for stopping 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, successful response of the operation. 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.
},
}

Cloud FTP API . projects . locations . servers

Instance Methods

Method Details