| <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="ces_v1beta.html">Gemini Enterprise for Customer Experience API</a> . <a href="ces_v1beta.projects.html">projects</a> . <a href="ces_v1beta.projects.locations.html">locations</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="ces_v1beta.projects.locations.apps.html">apps()</a></code> |
| </p> |
| <p class="firstline">Returns the apps Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="ces_v1beta.projects.locations.operations.html">operations()</a></code> |
| </p> |
| <p class="firstline">Returns the operations Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets information about a location.</p> |
| <p class="toc_element"> |
| <code><a href="#getSecuritySettings">getSecuritySettings(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves the security settings for the project and location.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#updateSecuritySettings">updateSecuritySettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the security settings for the project and location.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets information about a location. |
| |
| Args: |
| name: string, Resource name for the location. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A resource that represents a Google Cloud location. |
| "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
| "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| "a_key": "A String", |
| }, |
| "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. |
| "metadata": { # Service-specific metadata. For example the available capacity at the given location. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getSecuritySettings">getSecuritySettings(name, x__xgafv=None)</code> |
| <pre>Retrieves the security settings for the project and location. |
| |
| Args: |
| name: string, Required. The resource name of the security settings to retrieve. Format: `projects/{project}/locations/{location}/securitySettings` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Project/Location level security settings for CES. |
| "createTime": "A String", # Output only. Create time of the security settings. |
| "endpointControlPolicy": { # Defines project/location level endpoint control policy. # Optional. Endpoint control related settings. |
| "allowedOrigins": [ # Optional. The allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, "https://example.com" will match "https://example.com:443" and any other port. "https://example.com:443" will only match "https://example.com:443". |
| "A String", |
| ], |
| "enforcementScope": "A String", # Optional. The scope in which this policy's allowed_origins list is enforced. |
| }, |
| "etag": "A String", # Output only. Etag of the security settings. |
| "name": "A String", # Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings` |
| "updateTime": "A String", # Output only. Last update time of the security settings. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. |
| |
| Args: |
| name: string, The resource that owns the locations collection, if applicable. (required) |
| extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) |
| filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). |
| pageSize: integer, The maximum number of results to return. If not set, the service selects a default. |
| pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The response message for Locations.ListLocations. |
| "locations": [ # A list of locations that matches the specified filter in the request. |
| { # A resource that represents a Google Cloud location. |
| "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
| "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| "a_key": "A String", |
| }, |
| "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. |
| "metadata": { # Service-specific metadata. For example the available capacity at the given location. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| }, |
| ], |
| "nextPageToken": "A String", # The standard List next-page token. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</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 'execute()' 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="updateSecuritySettings">updateSecuritySettings(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates the security settings for the project and location. |
| |
| Args: |
| name: string, Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Project/Location level security settings for CES. |
| "createTime": "A String", # Output only. Create time of the security settings. |
| "endpointControlPolicy": { # Defines project/location level endpoint control policy. # Optional. Endpoint control related settings. |
| "allowedOrigins": [ # Optional. The allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, "https://example.com" will match "https://example.com:443" and any other port. "https://example.com:443" will only match "https://example.com:443". |
| "A String", |
| ], |
| "enforcementScope": "A String", # Optional. The scope in which this policy's allowed_origins list is enforced. |
| }, |
| "etag": "A String", # Output only. Etag of the security settings. |
| "name": "A String", # Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings` |
| "updateTime": "A String", # Output only. Last update time of the security settings. |
| } |
| |
| updateMask: string, Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Project/Location level security settings for CES. |
| "createTime": "A String", # Output only. Create time of the security settings. |
| "endpointControlPolicy": { # Defines project/location level endpoint control policy. # Optional. Endpoint control related settings. |
| "allowedOrigins": [ # Optional. The allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, "https://example.com" will match "https://example.com:443" and any other port. "https://example.com:443" will only match "https://example.com:443". |
| "A String", |
| ], |
| "enforcementScope": "A String", # Optional. The scope in which this policy's allowed_origins list is enforced. |
| }, |
| "etag": "A String", # Output only. Etag of the security settings. |
| "name": "A String", # Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings` |
| "updateTime": "A String", # Output only. Last update time of the security settings. |
| }</pre> |
| </div> |
| |
| </body></html> |
