<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="file_v1.html">Cloud Filestore API</a> . <a href="file_v1.projects.html">projects</a> . <a href="file_v1.projects.locations.html">locations</a> . <a href="file_v1.projects.locations.instances.html">instances</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an instance.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an instance.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the details of a specific instance.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all instances in a project for either a specified location</p>
<p class="toc_element">
  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the settings of a specific instance.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
  <pre>Creates an instance.

Args:
  parent: string, Required. The instance&#x27;s project and location, in the format
projects/{project_id}/locations/{location}. In Cloud Filestore,
locations map to GCP zones, for example **us-west1-b**. (required)
  body: object, The request body.
    The object takes the form of:

{ # A Cloud Filestore instance.
  &quot;fileShares&quot;: [ # File system shares on the instance.
      # For this version, only a single file share is supported.
    { # File share configuration for the instance.
      &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB).
          # Cloud Filestore defines 1 GB as 1024^3 bytes.
      &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 16 characters or less).
    },
  ],
  &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format
      # projects/{project}/locations/{location}/instances/{instance}.
  &quot;networks&quot;: [ # VPC networks to which the instance is connected.
      # For this version, only a single network is supported.
    { # Network configuration for the instance.
      &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
          # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
          # instance is connected.
      &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format
          # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
          # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
          # 7}:{block 8}.
        &quot;A String&quot;,
      ],
      &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses
          # assigned. For this version, only MODE_IPV4 is supported.
        &quot;A String&quot;,
      ],
      &quot;reservedIpRange&quot;: &quot;A String&quot;, # A /29 CIDR block in one of the
          # [internal IP address
          # ranges](https://www.arin.net/knowledge/address_filters.html) that
          # identifies the range of IP addresses reserved for this instance. For
          # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can&#x27;t overlap
          # with either existing subnets or assigned IP address ranges for other Cloud
          # Filestore instances in the selected VPC network.
    },
  ],
  &quot;labels&quot;: { # Resource labels to represent user provided metadata.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
  &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
  &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous
      # updates from overwriting each other.
  &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
}

  instanceId: string, Required. The name of the instance to create.
The name must be unique for the specified project and location.
  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.
    &quot;metadata&quot;: { # 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.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;name&quot;: &quot;A String&quot;, # 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}`.
    &quot;done&quot;: 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.
    &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # 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).
      &quot;message&quot;: &quot;A String&quot;, # 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.
      &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
      &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    &quot;response&quot;: { # 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`.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
  }</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes an instance.

Args:
  name: string, Required. The instance resource name, in the format
projects/{project_id}/locations/{location}/instances/{instance_id} (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.
    &quot;metadata&quot;: { # 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.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;name&quot;: &quot;A String&quot;, # 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}`.
    &quot;done&quot;: 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.
    &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # 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).
      &quot;message&quot;: &quot;A String&quot;, # 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.
      &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
      &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    &quot;response&quot;: { # 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`.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
  }</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets the details of a specific instance.

Args:
  name: string, Required. The instance resource name, in the format
projects/{project_id}/locations/{location}/instances/{instance_id}. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Cloud Filestore instance.
    &quot;fileShares&quot;: [ # File system shares on the instance.
        # For this version, only a single file share is supported.
      { # File share configuration for the instance.
        &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB).
            # Cloud Filestore defines 1 GB as 1024^3 bytes.
        &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 16 characters or less).
      },
    ],
    &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
    &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format
        # projects/{project}/locations/{location}/instances/{instance}.
    &quot;networks&quot;: [ # VPC networks to which the instance is connected.
        # For this version, only a single network is supported.
      { # Network configuration for the instance.
        &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
            # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
            # instance is connected.
        &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format
            # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
            # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
            # 7}:{block 8}.
          &quot;A String&quot;,
        ],
        &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses
            # assigned. For this version, only MODE_IPV4 is supported.
          &quot;A String&quot;,
        ],
        &quot;reservedIpRange&quot;: &quot;A String&quot;, # A /29 CIDR block in one of the
            # [internal IP address
            # ranges](https://www.arin.net/knowledge/address_filters.html) that
            # identifies the range of IP addresses reserved for this instance. For
            # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can&#x27;t overlap
            # with either existing subnets or assigned IP address ranges for other Cloud
            # Filestore instances in the selected VPC network.
      },
    ],
    &quot;labels&quot;: { # Resource labels to represent user provided metadata.
      &quot;a_key&quot;: &quot;A String&quot;,
    },
    &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
    &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
    &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous
        # updates from overwriting each other.
    &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
  }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
  <pre>Lists all instances in a project for either a specified location
or for all locations.

Args:
  parent: string, Required. The project and location for which to retrieve instance information,
in the format projects/{project_id}/locations/{location}. In Cloud
Filestore, locations map to GCP zones, for example **us-west1-b**. To
retrieve instance information for all locations, use &quot;-&quot; for the {location}
value. (required)
  filter: string, List filter.
  orderBy: string, Sort results. Supported values are &quot;name&quot;, &quot;name desc&quot; or &quot;&quot; (unsorted).
  pageToken: string, The next_page_token value to use if there are additional
results to retrieve for this list request.
  pageSize: integer, The maximum number of items to return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # ListInstancesResponse is the result of ListInstancesRequest.
    &quot;instances&quot;: [ # A list of instances in the project for the specified location.
        #
        # If the {location} value in the request is &quot;-&quot;, the response contains a list
        # of instances from all locations. If any location is unreachable, the
        # response will only return instances in reachable locations and the
        # &quot;unreachable&quot; field will be populated with a list of unreachable locations.
      { # A Cloud Filestore instance.
        &quot;fileShares&quot;: [ # File system shares on the instance.
            # For this version, only a single file share is supported.
          { # File share configuration for the instance.
            &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB).
                # Cloud Filestore defines 1 GB as 1024^3 bytes.
            &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 16 characters or less).
          },
        ],
        &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
        &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format
            # projects/{project}/locations/{location}/instances/{instance}.
        &quot;networks&quot;: [ # VPC networks to which the instance is connected.
            # For this version, only a single network is supported.
          { # Network configuration for the instance.
            &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
                # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
                # instance is connected.
            &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format
                # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
                # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
                # 7}:{block 8}.
              &quot;A String&quot;,
            ],
            &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses
                # assigned. For this version, only MODE_IPV4 is supported.
              &quot;A String&quot;,
            ],
            &quot;reservedIpRange&quot;: &quot;A String&quot;, # A /29 CIDR block in one of the
                # [internal IP address
                # ranges](https://www.arin.net/knowledge/address_filters.html) that
                # identifies the range of IP addresses reserved for this instance. For
                # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can&#x27;t overlap
                # with either existing subnets or assigned IP address ranges for other Cloud
                # Filestore instances in the selected VPC network.
          },
        ],
        &quot;labels&quot;: { # Resource labels to represent user provided metadata.
          &quot;a_key&quot;: &quot;A String&quot;,
        },
        &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
        &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
        &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
        &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous
            # updates from overwriting each other.
        &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
      },
    ],
    &quot;nextPageToken&quot;: &quot;A String&quot;, # The token you can use to retrieve the next page of results. Not returned
        # if there are no more results in the list.
    &quot;unreachable&quot;: [ # Locations that could not be reached.
      &quot;A String&quot;,
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
  <pre>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 &#x27;execute()&#x27; on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the settings of a specific instance.

Args:
  name: string, Output only. The resource name of the instance, in the format
projects/{project}/locations/{location}/instances/{instance}. (required)
  body: object, The request body.
    The object takes the form of:

{ # A Cloud Filestore instance.
  &quot;fileShares&quot;: [ # File system shares on the instance.
      # For this version, only a single file share is supported.
    { # File share configuration for the instance.
      &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB).
          # Cloud Filestore defines 1 GB as 1024^3 bytes.
      &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 16 characters or less).
    },
  ],
  &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
  &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format
      # projects/{project}/locations/{location}/instances/{instance}.
  &quot;networks&quot;: [ # VPC networks to which the instance is connected.
      # For this version, only a single network is supported.
    { # Network configuration for the instance.
      &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
          # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
          # instance is connected.
      &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format
          # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
          # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
          # 7}:{block 8}.
        &quot;A String&quot;,
      ],
      &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses
          # assigned. For this version, only MODE_IPV4 is supported.
        &quot;A String&quot;,
      ],
      &quot;reservedIpRange&quot;: &quot;A String&quot;, # A /29 CIDR block in one of the
          # [internal IP address
          # ranges](https://www.arin.net/knowledge/address_filters.html) that
          # identifies the range of IP addresses reserved for this instance. For
          # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can&#x27;t overlap
          # with either existing subnets or assigned IP address ranges for other Cloud
          # Filestore instances in the selected VPC network.
    },
  ],
  &quot;labels&quot;: { # Resource labels to represent user provided metadata.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
  &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
  &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous
      # updates from overwriting each other.
  &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
}

  updateMask: string, 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:

* &quot;description&quot;
* &quot;file_shares&quot;
* &quot;labels&quot;
  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.
    &quot;metadata&quot;: { # 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.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;name&quot;: &quot;A String&quot;, # 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}`.
    &quot;done&quot;: 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.
    &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # 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).
      &quot;message&quot;: &quot;A String&quot;, # 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.
      &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
      &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
    &quot;response&quot;: { # 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`.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
  }</pre>
</div>

</body></html>