Blame - docs/dyn/pubsub_v1beta1a.topics.html - platform/external/python/google-api-python-client

blob: a920e42d69d5cff2733097be526778091fd89344 [file] [log] [blame]

Craig Citro	065b530	2014-08-14 00:47:23 -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
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	75	<h1><a href="pubsub_v1beta1a.html">Cloud Pub/Sub API</a> . <a href="pubsub_v1beta1a.topics.html">topics</a></h1>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	81	<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	82	<p class="firstline">Creates the given topic with the given name.</p>
				83	<p class="toc_element">
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	84	<code><a href="#delete">delete(topic, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	85	<p class="firstline">Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	86	<p class="toc_element">
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	87	<code><a href="#get">get(topic, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	88	<p class="firstline">Gets the configuration of a topic. Since the topic only has the name attribute, this method is only useful to check the existence of a topic. If other attributes are added in the future, they will be returned here.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	89	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	90	<code><a href="#list">list(query=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	91	<p class="firstline">Lists matching topics.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<code><a href="#publish">publish(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	97	<p class="firstline">Adds a message to the topic. Returns NOT_FOUND if the topic does not exist.</p>
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	98	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	99	<code><a href="#publishBatch">publishBatch(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	100	<p class="firstline">Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.</p>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	101	<h3>Method Details</h3>
				102	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	103	<code class="details" id="close">close()</code>
				104	<pre>Close httplib2 connections.</pre>
				105	</div>
				106
				107	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	108	<code class="details" id="create">create(body=None, x__xgafv=None)</code>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	109	<pre>Creates the given topic with the given name.
				110
				111	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	112	body: object, The request body.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	113	The object takes the form of:
				114
				115	{ # A topic resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	116	"name": "A String", # Name of the topic.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	117	}
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	118
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	119	x__xgafv: string, V1 error format.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	120	Allowed values
				121	1 - v1 error format
				122	2 - v2 error format
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	123
				124	Returns:
				125	An object of the form:
				126
				127	{ # A topic resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	128	"name": "A String", # Name of the topic.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	129	}</pre>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	130	</div>
				131
				132	<div class="method">
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	133	<code class="details" id="delete">delete(topic, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	134	<pre>Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	135
				136	Args:
				137	topic: string, Name of the topic to delete. (required)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	138	x__xgafv: string, V1 error format.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	139	Allowed values
				140	1 - v1 error format
				141	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	142
				143	Returns:
				144	An object of the form:
				145
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	146	{ # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	147	}</pre>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	148	</div>
				149
				150	<div class="method">
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	151	<code class="details" id="get">get(topic, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	152	<pre>Gets the configuration of a topic. Since the topic only has the name attribute, this method is only useful to check the existence of a topic. If other attributes are added in the future, they will be returned here.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	153
				154	Args:
				155	topic: string, The name of the topic to get. (required)
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	156	x__xgafv: string, V1 error format.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	157	Allowed values
				158	1 - v1 error format
				159	2 - v2 error format
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	160
				161	Returns:
				162	An object of the form:
				163
				164	{ # A topic resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	165	"name": "A String", # Name of the topic.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	166	}</pre>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	167	</div>
				168
				169	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	170	<code class="details" id="list">list(query=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	171	<pre>Lists matching topics.
				172
				173	Args:
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	174	query: string, A valid label query expression.
				175	maxResults: integer, Maximum number of topics to return.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	176	pageToken: string, The value obtained in the last ListTopicsResponse for continuation.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	177	x__xgafv: string, V1 error format.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	178	Allowed values
				179	1 - v1 error format
				180	2 - v2 error format
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	181
				182	Returns:
				183	An object of the form:
				184
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	185	{ # Response for the ListTopics method.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	186	"topic": [ # The resulting topics.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	187	{ # A topic resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	188	"name": "A String", # Name of the topic.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	189	},
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	190	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	191	"nextPageToken": "A String", # If not empty, indicates that there are more topics that match the request, and this value should be passed to the next ListTopicsRequest to continue.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	192	}</pre>
				193	</div>
				194
				195	<div class="method">
				196	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				197	<pre>Retrieves the next page of results.
				198
				199	Args:
				200	previous_request: The request for the previous page. (required)
				201	previous_response: The response from the request for the previous page. (required)
				202
				203	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	204	A request object that you can call 'execute()' on to request the next
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	205	page. Returns None if there are no more items in the collection.
				206	</pre>
				207	</div>
				208
				209	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	210	<code class="details" id="publish">publish(body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	211	<pre>Adds a message to the topic. Returns NOT_FOUND if the topic does not exist.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	212
				213	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	214	body: object, The request body.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	215	The object takes the form of:
				216
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	217	{ # Request for the Publish method.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	218	"message": { # A message data and its labels. # The message to publish.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	219	"data": "A String", # The message payload.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	220	"publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch.
				221	"messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.
				222	"label": [ # Optional list of labels for this message. Keys in this collection must be unique.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	223	{ # A key-value pair applied to a given object.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	224	"key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated. Keys are defined by the following grammar: key = hostname "/" kpath kpath = ksegment [ "/" ksegment ] ksegment = alphadigit \| [ alphadigit \| "-" \| "_" \| "." ] where "hostname" and "alphadigit" are defined as in RFC 1738. Example key: spanner.google.com/universe
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	225	"strValue": "A String", # A string value.
				226	"numValue": "A String", # An integer value.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	227	},
				228	],
				229	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	230	"topic": "A String", # The message in the request will be published on this topic.
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	231	}
				232
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	233	x__xgafv: string, V1 error format.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	234	Allowed values
				235	1 - v1 error format
				236	2 - v2 error format
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	237
				238	Returns:
				239	An object of the form:
				240
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	241	{ # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	242	}</pre>
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	243	</div>
				244
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	245	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	246	<code class="details" id="publishBatch">publishBatch(body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	247	<pre>Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	248
				249	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	250	body: object, The request body.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	251	The object takes the form of:
				252
				253	{ # Request for the PublishBatch method.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	254	"topic": "A String", # The messages in the request will be published on this topic.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	255	"messages": [ # The messages to publish.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	256	{ # A message data and its labels.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	257	"data": "A String", # The message payload.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	258	"publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch.
				259	"messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.
				260	"label": [ # Optional list of labels for this message. Keys in this collection must be unique.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	261	{ # A key-value pair applied to a given object.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	262	"key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with the "scheme" and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The "host" portion is called the "namespace" and is not necessarily resolvable to a network endpoint. Instead, the namespace indicates what system or entity defines the semantics of the label. Namespaces do not restrict the set of objects to which a label may be associated. Keys are defined by the following grammar: key = hostname "/" kpath kpath = ksegment [ "/" ksegment ] ksegment = alphadigit \| [ alphadigit \| "-" \| "_" \| "." ] where "hostname" and "alphadigit" are defined as in RFC 1738. Example key: spanner.google.com/universe
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	263	"strValue": "A String", # A string value.
				264	"numValue": "A String", # An integer value.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	265	},
				266	],
				267	},
				268	],
				269	}
				270
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	271	x__xgafv: string, V1 error format.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	272	Allowed values
				273	1 - v1 error format
				274	2 - v2 error format
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	275
				276	Returns:
				277	An object of the form:
				278
				279	{ # Response for the PublishBatch method.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	280	"messageIds": [ # The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	281	"A String",
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	282	],
				283	}</pre>
				284	</div>
				285
Craig Citro	065b530	2014-08-14 00:47:23 -0700	[diff] [blame]	286	</body></html>