Cloud Location Finder API . projects . locations . cloudLocations

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Retrieves a resource containing information about a cloud location.

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:

    { # Represents resource cloud locations.
  "carbonFreeEnergyPercentage": 3.14, # Optional. The carbon free energy percentage of the cloud location. This represents the average percentage of time customers' application will be running on carbon-free energy. See https://cloud.google.com/sustainability/region-carbon for more details. There is a difference between default value 0 and unset value. 0 means the carbon free energy percentage is 0%, while unset value means the carbon footprint data is not available.
  "cloudLocationType": "A String", # Optional. The type of the cloud location.
  "cloudProvider": "A String", # Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
  "containingCloudLocation": "A String", # Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.
  "displayName": "A String", # Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.
  "gcpAttributes": { # GCP-specific attributes. # Optional. GCP-specific attributes.
    "zoneType": "A String", # Optional. The type of the cloud zone.
  },
  "name": "A String", # Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: `projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}`
  "territoryCode": "A String", # Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.
}

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

Lists cloud locations under a given project and location.

Args:
  parent: string, Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location} (required)
  filter: string, Optional. A filter expression that filters resources listed in the response. The expression is in the form of field=value. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION'. Multiple filter queries are space-separated. For example, 'cloud_location_type=CLOUD_LOCATION_TYPE_REGION territory_code="US"' By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.
  pageSize: integer, Optional. The maximum number of cloud locations to return per page. The service might return fewer cloud locations than this value. If unspecified, at most 500 cloud locations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A token identifying a page of results the server should return. Provide page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token.
  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 cloud locations.
  "cloudLocations": [ # Output only. List of cloud locations.
    { # Represents resource cloud locations.
      "carbonFreeEnergyPercentage": 3.14, # Optional. The carbon free energy percentage of the cloud location. This represents the average percentage of time customers' application will be running on carbon-free energy. See https://cloud.google.com/sustainability/region-carbon for more details. There is a difference between default value 0 and unset value. 0 means the carbon free energy percentage is 0%, while unset value means the carbon footprint data is not available.
      "cloudLocationType": "A String", # Optional. The type of the cloud location.
      "cloudProvider": "A String", # Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
      "containingCloudLocation": "A String", # Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.
      "displayName": "A String", # Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.
      "gcpAttributes": { # GCP-specific attributes. # Optional. GCP-specific attributes.
        "zoneType": "A String", # Optional. The type of the cloud zone.
      },
      "name": "A String", # Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: `projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}`
      "territoryCode": "A String", # Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.
    },
  ],
  "nextPageToken": "A String", # Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as page_token in subsequent requests to retrieve the next page. If this field is not present, there are no subsequent results.
}

list_next(previous_request, previous_response)

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.

search(parent, pageSize=None, pageToken=None, query=None, sourceCloudLocation=None, x__xgafv=None)

Searches for cloud locations from a given source location.

Args:
  parent: string, Required. The parent, which owns this collection of cloud locations. Format: projects/{project}/locations/{location} (required)
  pageSize: integer, Optional. The maximum number of cloud locations to return. The service might return fewer cloud locations than this value. If unspecified, at most 500 cloud locations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A token identifying a page of results the server should return. Provide Page token returned by a previous 'ListCloudLocations' call to retrieve the next page of results. When paginating, all other parameters provided to 'ListCloudLocations' must match the call that provided the page token.
  query: string, Optional. The query string in search query syntax. While filter is used to filter the search results by attributes, query is used to specify the search requirements.
  sourceCloudLocation: string, Required. The source cloud location to search from. Example search can be searching nearby cloud locations from the source cloud location by latency.
  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 searching cloud locations.
  "cloudLocations": [ # Output only. List of cloud locations.
    { # Represents resource cloud locations.
      "carbonFreeEnergyPercentage": 3.14, # Optional. The carbon free energy percentage of the cloud location. This represents the average percentage of time customers' application will be running on carbon-free energy. See https://cloud.google.com/sustainability/region-carbon for more details. There is a difference between default value 0 and unset value. 0 means the carbon free energy percentage is 0%, while unset value means the carbon footprint data is not available.
      "cloudLocationType": "A String", # Optional. The type of the cloud location.
      "cloudProvider": "A String", # Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
      "containingCloudLocation": "A String", # Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.
      "displayName": "A String", # Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.
      "gcpAttributes": { # GCP-specific attributes. # Optional. GCP-specific attributes.
        "zoneType": "A String", # Optional. The type of the cloud zone.
      },
      "name": "A String", # Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: `projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}`
      "territoryCode": "A String", # Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.
    },
  ],
  "nextPageToken": "A String", # Output only. The continuation token, used to page through large result sets. Provide this value in a subsequent request as page_token in subsequent requests to retrieve the next page. If this field is not present, there are no subsequent results.
}

search_next(previous_request, previous_response)

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.