Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Create an NFS share.
Delete an NFS share. The underlying volume is automatically deleted.
Get details of a single NFS share.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
List NFS shares.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Update details of a single NFS share.
rename(name, body=None, x__xgafv=None)
RenameNfsShare sets a new name for an nfsshare. Use with caution, previous names become immediately invalidated.
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Create an NFS share.
Args:
parent: string, Required. The parent project and location. (required)
body: object, The request body.
The object takes the form of:
{ # An NFS share.
"allowedClients": [ # List of allowed access points.
{ # Represents an 'access point' for the share.
"allowDev": True or False, # Allow dev flag. Which controls whether to allow creation of devices.
"allowSuid": True or False, # Allow the setuid flag.
"allowedClientsCidr": "A String", # The subnet of IP addresses permitted to access the share.
"mountPermissions": "A String", # Mount permissions.
"network": "A String", # The network the access point sits on.
"nfsPath": "A String", # Output only. The path to access NFS, in format shareIP:/InstanceID InstanceID is the generated ID instead of customer provided name. example like "10.0.0.0:/g123456789-nfs001"
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.
"shareIp": "A String", # Output only. The IP address of the share on this network. Assigned automatically during provisioning based on the network's services_cidr.
},
],
"id": "A String", # Output only. An identifier for the NFS share, generated by the backend. This is the same value as nfs_share_id and will replace it in the future.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"name": "A String", # Immutable. The name of the NFS share.
"nfsShareId": "A String", # Output only. An identifier for the NFS share, generated by the backend. This field will be deprecated in the future, use `id` instead.
"pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. NFSShare can only be connected to the assets (networks, instances) allocated in the same pod.
"requestedSizeGib": "A String", # The requested size, in GiB.
"state": "A String", # Output only. The state of the NFS share.
"storageType": "A String", # Immutable. The storage type of the underlying volume.
"volume": "A String", # Output only. The underlying volume of the share. Created automatically during provisioning.
}
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)
Delete an NFS share. The underlying volume is automatically deleted.
Args:
name: string, Required. The name of the NFS share to delete. (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, x__xgafv=None)
Get details of a single NFS share.
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:
{ # An NFS share.
"allowedClients": [ # List of allowed access points.
{ # Represents an 'access point' for the share.
"allowDev": True or False, # Allow dev flag. Which controls whether to allow creation of devices.
"allowSuid": True or False, # Allow the setuid flag.
"allowedClientsCidr": "A String", # The subnet of IP addresses permitted to access the share.
"mountPermissions": "A String", # Mount permissions.
"network": "A String", # The network the access point sits on.
"nfsPath": "A String", # Output only. The path to access NFS, in format shareIP:/InstanceID InstanceID is the generated ID instead of customer provided name. example like "10.0.0.0:/g123456789-nfs001"
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.
"shareIp": "A String", # Output only. The IP address of the share on this network. Assigned automatically during provisioning based on the network's services_cidr.
},
],
"id": "A String", # Output only. An identifier for the NFS share, generated by the backend. This is the same value as nfs_share_id and will replace it in the future.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"name": "A String", # Immutable. The name of the NFS share.
"nfsShareId": "A String", # Output only. An identifier for the NFS share, generated by the backend. This field will be deprecated in the future, use `id` instead.
"pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. NFSShare can only be connected to the assets (networks, instances) allocated in the same pod.
"requestedSizeGib": "A String", # The requested size, in GiB.
"state": "A String", # Output only. The state of the NFS share.
"storageType": "A String", # Immutable. The storage type of the underlying volume.
"volume": "A String", # Output only. The underlying volume of the share. Created automatically during provisioning.
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
List NFS shares.
Args:
parent: string, Required. Parent value for ListNfsSharesRequest. (required)
filter: string, List filter.
pageSize: integer, Requested page size. The server might return fewer items than requested. If unspecified, 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 containing the list of NFS shares.
"nextPageToken": "A String", # A token identifying a page of results from the server.
"nfsShares": [ # The list of NFS shares.
{ # An NFS share.
"allowedClients": [ # List of allowed access points.
{ # Represents an 'access point' for the share.
"allowDev": True or False, # Allow dev flag. Which controls whether to allow creation of devices.
"allowSuid": True or False, # Allow the setuid flag.
"allowedClientsCidr": "A String", # The subnet of IP addresses permitted to access the share.
"mountPermissions": "A String", # Mount permissions.
"network": "A String", # The network the access point sits on.
"nfsPath": "A String", # Output only. The path to access NFS, in format shareIP:/InstanceID InstanceID is the generated ID instead of customer provided name. example like "10.0.0.0:/g123456789-nfs001"
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.
"shareIp": "A String", # Output only. The IP address of the share on this network. Assigned automatically during provisioning based on the network's services_cidr.
},
],
"id": "A String", # Output only. An identifier for the NFS share, generated by the backend. This is the same value as nfs_share_id and will replace it in the future.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"name": "A String", # Immutable. The name of the NFS share.
"nfsShareId": "A String", # Output only. An identifier for the NFS share, generated by the backend. This field will be deprecated in the future, use `id` instead.
"pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. NFSShare can only be connected to the assets (networks, instances) allocated in the same pod.
"requestedSizeGib": "A String", # The requested size, in GiB.
"state": "A String", # Output only. The state of the NFS share.
"storageType": "A String", # Immutable. The storage type of the underlying volume.
"volume": "A String", # Output only. The underlying volume of the share. Created automatically during provisioning.
},
],
"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 NFS share.
Args:
name: string, Immutable. The name of the NFS share. (required)
body: object, The request body.
The object takes the form of:
{ # An NFS share.
"allowedClients": [ # List of allowed access points.
{ # Represents an 'access point' for the share.
"allowDev": True or False, # Allow dev flag. Which controls whether to allow creation of devices.
"allowSuid": True or False, # Allow the setuid flag.
"allowedClientsCidr": "A String", # The subnet of IP addresses permitted to access the share.
"mountPermissions": "A String", # Mount permissions.
"network": "A String", # The network the access point sits on.
"nfsPath": "A String", # Output only. The path to access NFS, in format shareIP:/InstanceID InstanceID is the generated ID instead of customer provided name. example like "10.0.0.0:/g123456789-nfs001"
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.
"shareIp": "A String", # Output only. The IP address of the share on this network. Assigned automatically during provisioning based on the network's services_cidr.
},
],
"id": "A String", # Output only. An identifier for the NFS share, generated by the backend. This is the same value as nfs_share_id and will replace it in the future.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"name": "A String", # Immutable. The name of the NFS share.
"nfsShareId": "A String", # Output only. An identifier for the NFS share, generated by the backend. This field will be deprecated in the future, use `id` instead.
"pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. NFSShare can only be connected to the assets (networks, instances) allocated in the same pod.
"requestedSizeGib": "A String", # The requested size, in GiB.
"state": "A String", # Output only. The state of the NFS share.
"storageType": "A String", # Immutable. The storage type of the underlying volume.
"volume": "A String", # Output only. The underlying volume of the share. Created automatically during provisioning.
}
updateMask: string, The list of fields to update. The only currently supported fields are: `labels` `allowed_clients`
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.
},
}
rename(name, body=None, x__xgafv=None)
RenameNfsShare sets a new name for an nfsshare. Use with caution, previous names become immediately invalidated.
Args:
name: string, Required. The `name` field is used to identify the nfsshare. Format: projects/{project}/locations/{location}/nfsshares/{nfsshare} (required)
body: object, The request body.
The object takes the form of:
{ # Message requesting rename of a server.
"newNfsshareId": "A String", # Required. The new `id` of the nfsshare.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An NFS share.
"allowedClients": [ # List of allowed access points.
{ # Represents an 'access point' for the share.
"allowDev": True or False, # Allow dev flag. Which controls whether to allow creation of devices.
"allowSuid": True or False, # Allow the setuid flag.
"allowedClientsCidr": "A String", # The subnet of IP addresses permitted to access the share.
"mountPermissions": "A String", # Mount permissions.
"network": "A String", # The network the access point sits on.
"nfsPath": "A String", # Output only. The path to access NFS, in format shareIP:/InstanceID InstanceID is the generated ID instead of customer provided name. example like "10.0.0.0:/g123456789-nfs001"
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.
"shareIp": "A String", # Output only. The IP address of the share on this network. Assigned automatically during provisioning based on the network's services_cidr.
},
],
"id": "A String", # Output only. An identifier for the NFS share, generated by the backend. This is the same value as nfs_share_id and will replace it in the future.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"name": "A String", # Immutable. The name of the NFS share.
"nfsShareId": "A String", # Output only. An identifier for the NFS share, generated by the backend. This field will be deprecated in the future, use `id` instead.
"pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. NFSShare can only be connected to the assets (networks, instances) allocated in the same pod.
"requestedSizeGib": "A String", # The requested size, in GiB.
"state": "A String", # Output only. The state of the NFS share.
"storageType": "A String", # Immutable. The storage type of the underlying volume.
"volume": "A String", # Output only. The underlying volume of the share. Created automatically during provisioning.
}