Blame - docs/dyn/pubsublite_v1.admin.projects.locations.topics.html - platform/external/python/google-api-python-client

blob: dbf66dd094e4dcb9d665e241e981e454e0cf6c1d [file] [log] [blame]

Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="pubsublite_v1.html">Pub/Sub Lite API</a> . <a href="pubsublite_v1.admin.html">admin</a> . <a href="pubsublite_v1.admin.projects.html">projects</a> . <a href="pubsublite_v1.admin.projects.locations.html">locations</a> . <a href="pubsublite_v1.admin.projects.locations.topics.html">topics</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="pubsublite_v1.admin.projects.locations.topics.subscriptions.html">subscriptions()</a></code>
				79	</p>
				80	<p class="firstline">Returns the subscriptions Resource.</p>
				81
				82	<p class="toc_element">
				83	<code><a href="#close">close()</a></code></p>
				84	<p class="firstline">Close httplib2 connections.</p>
				85	<p class="toc_element">
				86	<code><a href="#create">create(parent, body=None, topicId=None, x__xgafv=None)</a></code></p>
				87	<p class="firstline">Creates a new topic.</p>
				88	<p class="toc_element">
				89	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				90	<p class="firstline">Deletes the specified topic.</p>
				91	<p class="toc_element">
				92	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				93	<p class="firstline">Returns the topic configuration.</p>
				94	<p class="toc_element">
				95	<code><a href="#getPartitions">getPartitions(name, x__xgafv=None)</a></code></p>
				96	<p class="firstline">Returns the partition information for the requested topic.</p>
				97	<p class="toc_element">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	98	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	99	<p class="firstline">Returns the list of topics for the given project.</p>
				100	<p class="toc_element">
				101	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				102	<p class="firstline">Retrieves the next page of results.</p>
				103	<p class="toc_element">
				104	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				105	<p class="firstline">Updates properties of the specified topic.</p>
				106	<h3>Method Details</h3>
				107	<div class="method">
				108	<code class="details" id="close">close()</code>
				109	<pre>Close httplib2 connections.</pre>
				110	</div>
				111
				112	<div class="method">
				113	<code class="details" id="create">create(parent, body=None, topicId=None, x__xgafv=None)</code>
				114	<pre>Creates a new topic.
				115
				116	Args:
				117	parent: string, Required. The parent location in which to create the topic. Structured like `projects/{project_number}/locations/{location}`. (required)
				118	body: object, The request body.
				119	The object takes the form of:
				120
				121	{ # Metadata about a topic resource.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	122	"partitionConfig": { # The settings for a topic's partitions. # The settings for this topic's partitions.
				123	"count": "A String", # The number of partitions in the topic. Must be at least 1.
				124	"capacity": { # The throughput capacity configuration for each partition. # The capacity configuration.
				125	"subscribeMibPerSec": 42, # Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
				126	"publishMibPerSec": 42, # Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
				127	},
				128	"scale": 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	129	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	130	"retentionConfig": { # The settings for a topic's message retention. # The settings for this topic's message retention.
				131	"period": "A String", # How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`.
				132	"perPartitionBytes": "A String", # The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`.
				133	},
				134	"name": "A String", # The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
				135	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	136
				137	topicId: string, Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`.
				138	x__xgafv: string, V1 error format.
				139	Allowed values
				140	1 - v1 error format
				141	2 - v2 error format
				142
				143	Returns:
				144	An object of the form:
				145
				146	{ # Metadata about a topic resource.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	147	"partitionConfig": { # The settings for a topic's partitions. # The settings for this topic's partitions.
				148	"count": "A String", # The number of partitions in the topic. Must be at least 1.
				149	"capacity": { # The throughput capacity configuration for each partition. # The capacity configuration.
				150	"subscribeMibPerSec": 42, # Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
				151	"publishMibPerSec": 42, # Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
				152	},
				153	"scale": 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	154	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	155	"retentionConfig": { # The settings for a topic's message retention. # The settings for this topic's message retention.
				156	"period": "A String", # How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`.
				157	"perPartitionBytes": "A String", # The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`.
				158	},
				159	"name": "A String", # The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
				160	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	161	</div>
				162
				163	<div class="method">
				164	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				165	<pre>Deletes the specified topic.
				166
				167	Args:
				168	name: string, Required. The name of the topic to delete. (required)
				169	x__xgafv: string, V1 error format.
				170	Allowed values
				171	1 - v1 error format
				172	2 - v2 error format
				173
				174	Returns:
				175	An object of the form:
				176
				177	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
				178	}</pre>
				179	</div>
				180
				181	<div class="method">
				182	<code class="details" id="get">get(name, x__xgafv=None)</code>
				183	<pre>Returns the topic configuration.
				184
				185	Args:
				186	name: string, Required. The name of the topic whose configuration to return. (required)
				187	x__xgafv: string, V1 error format.
				188	Allowed values
				189	1 - v1 error format
				190	2 - v2 error format
				191
				192	Returns:
				193	An object of the form:
				194
				195	{ # Metadata about a topic resource.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	196	"partitionConfig": { # The settings for a topic's partitions. # The settings for this topic's partitions.
				197	"count": "A String", # The number of partitions in the topic. Must be at least 1.
				198	"capacity": { # The throughput capacity configuration for each partition. # The capacity configuration.
				199	"subscribeMibPerSec": 42, # Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
				200	"publishMibPerSec": 42, # Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
				201	},
				202	"scale": 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	203	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	204	"retentionConfig": { # The settings for a topic's message retention. # The settings for this topic's message retention.
				205	"period": "A String", # How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`.
				206	"perPartitionBytes": "A String", # The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`.
				207	},
				208	"name": "A String", # The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
				209	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	210	</div>
				211
				212	<div class="method">
				213	<code class="details" id="getPartitions">getPartitions(name, x__xgafv=None)</code>
				214	<pre>Returns the partition information for the requested topic.
				215
				216	Args:
				217	name: string, Required. The topic whose partition information to return. (required)
				218	x__xgafv: string, V1 error format.
				219	Allowed values
				220	1 - v1 error format
				221	2 - v2 error format
				222
				223	Returns:
				224	An object of the form:
				225
				226	{ # Response for GetTopicPartitions.
				227	"partitionCount": "A String", # The number of partitions in the topic.
				228	}</pre>
				229	</div>
				230
				231	<div class="method">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	232	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	233	<pre>Returns the list of topics for the given project.
				234
				235	Args:
				236	parent: string, Required. The parent whose topics are to be listed. Structured like `projects/{project_number}/locations/{location}`. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	237	pageSize: integer, The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent will be returned.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	238	pageToken: string, A page token, received from a previous `ListTopics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopics` must match the call that provided the page token.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	239	x__xgafv: string, V1 error format.
				240	Allowed values
				241	1 - v1 error format
				242	2 - v2 error format
				243
				244	Returns:
				245	An object of the form:
				246
				247	{ # Response for ListTopics.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	248	"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	249	"topics": [ # The list of topic in the requested parent. The order of the topics is unspecified.
				250	{ # Metadata about a topic resource.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	251	"partitionConfig": { # The settings for a topic's partitions. # The settings for this topic's partitions.
				252	"count": "A String", # The number of partitions in the topic. Must be at least 1.
				253	"capacity": { # The throughput capacity configuration for each partition. # The capacity configuration.
				254	"subscribeMibPerSec": 42, # Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
				255	"publishMibPerSec": 42, # Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
				256	},
				257	"scale": 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	258	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	259	"retentionConfig": { # The settings for a topic's message retention. # The settings for this topic's message retention.
				260	"period": "A String", # How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`.
				261	"perPartitionBytes": "A String", # The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`.
				262	},
				263	"name": "A String", # The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	264	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	265	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	266	}</pre>
				267	</div>
				268
				269	<div class="method">
				270	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				271	<pre>Retrieves the next page of results.
				272
				273	Args:
				274	previous_request: The request for the previous page. (required)
				275	previous_response: The response from the request for the previous page. (required)
				276
				277	Returns:
				278	A request object that you can call 'execute()' on to request the next
				279	page. Returns None if there are no more items in the collection.
				280	</pre>
				281	</div>
				282
				283	<div class="method">
				284	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				285	<pre>Updates properties of the specified topic.
				286
				287	Args:
				288	name: string, The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} (required)
				289	body: object, The request body.
				290	The object takes the form of:
				291
				292	{ # Metadata about a topic resource.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	293	"partitionConfig": { # The settings for a topic's partitions. # The settings for this topic's partitions.
				294	"count": "A String", # The number of partitions in the topic. Must be at least 1.
				295	"capacity": { # The throughput capacity configuration for each partition. # The capacity configuration.
				296	"subscribeMibPerSec": 42, # Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
				297	"publishMibPerSec": 42, # Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
				298	},
				299	"scale": 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	300	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	301	"retentionConfig": { # The settings for a topic's message retention. # The settings for this topic's message retention.
				302	"period": "A String", # How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`.
				303	"perPartitionBytes": "A String", # The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`.
				304	},
				305	"name": "A String", # The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
				306	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	307
				308	updateMask: string, Required. A mask specifying the topic fields to change.
				309	x__xgafv: string, V1 error format.
				310	Allowed values
				311	1 - v1 error format
				312	2 - v2 error format
				313
				314	Returns:
				315	An object of the form:
				316
				317	{ # Metadata about a topic resource.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	318	"partitionConfig": { # The settings for a topic's partitions. # The settings for this topic's partitions.
				319	"count": "A String", # The number of partitions in the topic. Must be at least 1.
				320	"capacity": { # The throughput capacity configuration for each partition. # The capacity configuration.
				321	"subscribeMibPerSec": 42, # Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
				322	"publishMibPerSec": 42, # Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
				323	},
				324	"scale": 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	325	},
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	326	"retentionConfig": { # The settings for a topic's message retention. # The settings for this topic's message retention.
				327	"period": "A String", # How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`.
				328	"perPartitionBytes": "A String", # The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`.
				329	},
				330	"name": "A String", # The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
				331	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	332	</div>
				333
				334	</body></html>