Cloud Filestore API (file:v1beta1)

2022-06-05

5 new methods

Additions

    Methods
  • file.projects.locations.instances.shares.get

      Parameters :

        name

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+/shares/[^/]+$

          Location : path

          Description : Required. The share resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}/shares/{share_id}`

          Required : Yes

      Description : Gets the details of a specific share.

      Parameter Order : name

      HTTP Method : GET

      Path : v1beta1/{+name}

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/shares/{sharesId}

  • file.projects.locations.instances.shares.delete

      Path : v1beta1/{+name}

      Parameters :

        name

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+/shares/[^/]+$

          Type : string

          Description : Required. The share resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}/share/{share_id}`

          Location : path

      Description : Deletes a share.

      HTTP Method : DELETE

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : name

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/shares/{sharesId}

  • file.projects.locations.instances.shares.patch

      Path : v1beta1/{+name}

      Description : Updates the settings of a specific share.

      HTTP Method : PATCH

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        name

          Type : string

          Description : Output only. The resource name of the share, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}/shares/{share_id}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+/shares/[^/]+$

          Location : path

          Required : Yes

        updateMask

          Type : string

          Description : Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "capacity_gb" * "labels" * "nfs_export_options"

          Format : google-fieldmask

          Location : query

      Parameter Order : name

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/shares/{sharesId}

  • file.projects.locations.instances.shares.create

      HTTP Method : POST

      Description : Creates a share.

      Path : v1beta1/{+parent}/shares

      Parameters :

        shareId

          Location : query

          Description : Required. The ID to use for the share. The ID must be unique within the specified instance. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.

          Type : string

        parent

          Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

          Type : string

          Required : Yes

          Location : path

          Description : Required. The Filestore Instance to create the share for, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`

      Parameter Order : parent

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/shares

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • file.projects.locations.instances.shares.list

      Description : Lists all shares for a specified instance.

      HTTP Method : GET

      Path : v1beta1/{+parent}/shares

      Parameters :

        filter

          Location : query

          Type : string

          Description : List filter.

        pageSize

          Description : The maximum number of items to return.

          Location : query

          Format : int32

          Type : integer

        parent

          Type : string

          Location : path

          Required : Yes

          Description : Required. The instance for which to retrieve share information, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

        orderBy

          Location : query

          Type : string

          Description : Sort results. Supported values are "name", "name desc" or "" (unsorted).

        pageToken

          Description : The next_page_token value to use if there are additional results to retrieve for this list request.

          Type : string

          Location : query

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/shares