docs/dyn/eventarc_v1.projects.locations.html - platform/external/python/google-api-python-client - Git at Google

 <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="eventarc_v1.html">Eventarc API</a> . <a href="eventarc_v1.projects.html">projects</a> . <a href="eventarc_v1.projects.locations.html">locations</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="eventarc_v1.projects.locations.channelConnections.html">channelConnections()</a></code>
 </p>
 <p class="firstline">Returns the channelConnections Resource.</p>

 <p class="toc_element">
   <code><a href="eventarc_v1.projects.locations.channels.html">channels()</a></code>
 </p>
 <p class="firstline">Returns the channels Resource.</p>

 <p class="toc_element">
   <code><a href="eventarc_v1.projects.locations.enrollments.html">enrollments()</a></code>
 </p>
 <p class="firstline">Returns the enrollments Resource.</p>

 <p class="toc_element">
   <code><a href="eventarc_v1.projects.locations.googleApiSources.html">googleApiSources()</a></code>
 </p>
 <p class="firstline">Returns the googleApiSources Resource.</p>

 <p class="toc_element">
   <code><a href="eventarc_v1.projects.locations.kafkaSources.html">kafkaSources()</a></code>
 </p>
 <p class="firstline">Returns the kafkaSources Resource.</p>

 <p class="toc_element">
   <code><a href="eventarc_v1.projects.locations.messageBuses.html">messageBuses()</a></code>
 </p>
 <p class="firstline">Returns the messageBuses Resource.</p>

 <p class="toc_element">
   <code><a href="eventarc_v1.projects.locations.operations.html">operations()</a></code>
 </p>
 <p class="firstline">Returns the operations Resource.</p>

 <p class="toc_element">
   <code><a href="eventarc_v1.projects.locations.pipelines.html">pipelines()</a></code>
 </p>
 <p class="firstline">Returns the pipelines Resource.</p>

 <p class="toc_element">
   <code><a href="eventarc_v1.projects.locations.providers.html">providers()</a></code>
 </p>
 <p class="firstline">Returns the providers Resource.</p>

 <p class="toc_element">
   <code><a href="eventarc_v1.projects.locations.triggers.html">triggers()</a></code>
 </p>
 <p class="firstline">Returns the triggers 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="#getGoogleChannelConfig">getGoogleChannelConfig(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Get a GoogleChannelConfig. The name of the GoogleChannelConfig in the response is ALWAYS coded with projectID.</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.</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="#updateGoogleChannelConfig">updateGoogleChannelConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Update a single GoogleChannelConfig</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.
   &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
   &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
     &quot;a_key&quot;: &quot;A String&quot;,
   },
   &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
   &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
     &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
   },
   &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
 }</pre>
 </div>

 <div class="method">
     <code class="details" id="getGoogleChannelConfig">getGoogleChannelConfig(name, x__xgafv=None)</code>
   <pre>Get a GoogleChannelConfig. The name of the GoogleChannelConfig in the response is ALWAYS coded with projectID.

 Args:
   name: string, Required. The name of the config to get. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # A GoogleChannelConfig is a resource that stores the custom settings respected by Eventarc first-party triggers in the matching region. Once configured, first-party event data will be protected using the specified custom managed encryption key instead of Google-managed encryption keys.
   &quot;cryptoKeyName&quot;: &quot;A String&quot;, # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
   &quot;labels&quot;: { # Optional. Resource labels.
     &quot;a_key&quot;: &quot;A String&quot;,
   },
   &quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
 }</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.

 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
   extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `&quot;displayName=tokyo&quot;`, 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.
   &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
     { # A resource that represents a Google Cloud location.
       &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
       &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
         &quot;a_key&quot;: &quot;A String&quot;,
       },
       &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
       &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
         &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
       },
       &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
     },
   ],
   &quot;nextPageToken&quot;: &quot;A String&quot;, # 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 &#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="updateGoogleChannelConfig">updateGoogleChannelConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
   <pre>Update a single GoogleChannelConfig

 Args:
   name: string, Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided. (required)
   body: object, The request body.
     The object takes the form of:

 { # A GoogleChannelConfig is a resource that stores the custom settings respected by Eventarc first-party triggers in the matching region. Once configured, first-party event data will be protected using the specified custom managed encryption key instead of Google-managed encryption keys.
   &quot;cryptoKeyName&quot;: &quot;A String&quot;, # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
   &quot;labels&quot;: { # Optional. Resource labels.
     &quot;a_key&quot;: &quot;A String&quot;,
   },
   &quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
 }

   updateMask: string, The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of &quot;*&quot;.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # A GoogleChannelConfig is a resource that stores the custom settings respected by Eventarc first-party triggers in the matching region. Once configured, first-party event data will be protected using the specified custom managed encryption key instead of Google-managed encryption keys.
   &quot;cryptoKeyName&quot;: &quot;A String&quot;, # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
   &quot;labels&quot;: { # Optional. Resource labels.
     &quot;a_key&quot;: &quot;A String&quot;,
   },
   &quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
 }</pre>
 </div>

 </body></html>
	<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="eventarc_v1.html">Eventarc API</a> . <a href="eventarc_v1.projects.html">projects</a> . <a href="eventarc_v1.projects.locations.html">locations</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="eventarc_v1.projects.locations.channelConnections.html">channelConnections()</a></code>
	</p>
	<p class="firstline">Returns the channelConnections Resource.</p>

	<p class="toc_element">
	<code><a href="eventarc_v1.projects.locations.channels.html">channels()</a></code>
	</p>
	<p class="firstline">Returns the channels Resource.</p>

	<p class="toc_element">
	<code><a href="eventarc_v1.projects.locations.enrollments.html">enrollments()</a></code>
	</p>
	<p class="firstline">Returns the enrollments Resource.</p>

	<p class="toc_element">
	<code><a href="eventarc_v1.projects.locations.googleApiSources.html">googleApiSources()</a></code>
	</p>
	<p class="firstline">Returns the googleApiSources Resource.</p>

	<p class="toc_element">
	<code><a href="eventarc_v1.projects.locations.kafkaSources.html">kafkaSources()</a></code>
	</p>
	<p class="firstline">Returns the kafkaSources Resource.</p>

	<p class="toc_element">
	<code><a href="eventarc_v1.projects.locations.messageBuses.html">messageBuses()</a></code>
	</p>
	<p class="firstline">Returns the messageBuses Resource.</p>

	<p class="toc_element">
	<code><a href="eventarc_v1.projects.locations.operations.html">operations()</a></code>
	</p>
	<p class="firstline">Returns the operations Resource.</p>

	<p class="toc_element">
	<code><a href="eventarc_v1.projects.locations.pipelines.html">pipelines()</a></code>
	</p>
	<p class="firstline">Returns the pipelines Resource.</p>

	<p class="toc_element">
	<code><a href="eventarc_v1.projects.locations.providers.html">providers()</a></code>
	</p>
	<p class="firstline">Returns the providers Resource.</p>

	<p class="toc_element">
	<code><a href="eventarc_v1.projects.locations.triggers.html">triggers()</a></code>
	</p>
	<p class="firstline">Returns the triggers 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="#getGoogleChannelConfig">getGoogleChannelConfig(name, x__xgafv=None)</a></code></p>
	<p class="firstline">Get a GoogleChannelConfig. The name of the GoogleChannelConfig in the response is ALWAYS coded with projectID.</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.</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="#updateGoogleChannelConfig">updateGoogleChannelConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Update a single GoogleChannelConfig</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="getGoogleChannelConfig">getGoogleChannelConfig(name, x__xgafv=None)</code>
	<pre>Get a GoogleChannelConfig. The name of the GoogleChannelConfig in the response is ALWAYS coded with projectID.

	Args:
	name: string, Required. The name of the config to get. (required)
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # A GoogleChannelConfig is a resource that stores the custom settings respected by Eventarc first-party triggers in the matching region. Once configured, first-party event data will be protected using the specified custom managed encryption key instead of Google-managed encryption keys.
	"cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects//locations//keyRings//cryptoKeys/`.
	"labels": { # Optional. Resource labels.
	"a_key": "A String",
	},
	"name": "A String", # Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided.
	"updateTime": "A String", # Output only. The last-modified time.
	}</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.

	Args:
	name: string, The resource that owns the locations collection, if applicable. (required)
	extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (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="updateGoogleChannelConfig">updateGoogleChannelConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
	<pre>Update a single GoogleChannelConfig

	Args:
	name: string, Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided. (required)
	body: object, The request body.
	The object takes the form of:

	{ # A GoogleChannelConfig is a resource that stores the custom settings respected by Eventarc first-party triggers in the matching region. Once configured, first-party event data will be protected using the specified custom managed encryption key instead of Google-managed encryption keys.
	"cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects//locations//keyRings//cryptoKeys/`.
	"labels": { # Optional. Resource labels.
	"a_key": "A String",
	},
	"name": "A String", # Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided.
	"updateTime": "A String", # Output only. The last-modified time.
	}

	updateMask: string, The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*".
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # A GoogleChannelConfig is a resource that stores the custom settings respected by Eventarc first-party triggers in the matching region. Once configured, first-party event data will be protected using the specified custom managed encryption key instead of Google-managed encryption keys.
	"cryptoKeyName": "A String", # Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects//locations//keyRings//cryptoKeys/`.
	"labels": { # Optional. Resource labels.
	"a_key": "A String",
	},
	"name": "A String", # Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. In API responses, the config name always includes the projectID, regardless of whether the projectID or projectNumber was provided.
	"updateTime": "A String", # Output only. The last-modified time.
	}</pre>
	</div>

	</body></html>