Blame - docs/dyn/cloudtrace_v2beta1.projects.traceSinks.html - platform/external/python/google-api-python-client

blob: 2085fe950780fdedaee5388e22dd13c659154f61 [file] [log] [blame]

Bu Sun Kim	6502091	2020-05-20 12:08:20 -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="cloudtrace_v2beta1.html">Cloud Trace API</a> . <a href="cloudtrace_v2beta1.projects.html">projects</a> . <a href="cloudtrace_v2beta1.projects.traceSinks.html">traceSinks</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
				79	<p class="firstline">Creates a sink that exports trace spans to a destination. The</p>
				80	<p class="toc_element">
				81	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Deletes a sink.</p>
				83	<p class="toc_element">
				84	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Get a trace sink by name under the parent resource (GCP project).</p>
				86	<p class="toc_element">
				87	<code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
				88	<p class="firstline">List all sinks for the parent resource (GCP project).</p>
				89	<p class="toc_element">
				90	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				91	<p class="firstline">Retrieves the next page of results.</p>
				92	<p class="toc_element">
				93	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				94	<p class="firstline">Updates a sink. This method updates fields in the existing sink according</p>
				95	<h3>Method Details</h3>
				96	<div class="method">
				97	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
				98	<pre>Creates a sink that exports trace spans to a destination. The
				99	export of newly-ingested traces begins immediately, unless the sink's
				100	`writer_identity` is not permitted to write to the destination. A sink can
				101	export traces only from the resource owning the sink (the 'parent').
				102
				103	Args:
				104	parent: string, Required. The resource in which to create the sink (currently only project
				105	sinks are supported):
				106
				107	"projects/[PROJECT_ID]"
				108
				109	Examples: `"projects/my-trace-project"`, `"projects/123456789"`. (required)
				110	body: object, The request body.
				111	The object takes the form of:
				112
				113	{ # Describes a sink used to export traces to a BigQuery dataset. The sink must
				114	# be created within a project.
				115	"name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the
				116	# form:
				117	#
				118	# project/[PROJECT_NUMBER]/traceSinks/[SINK_ID].
				119	#
				120	# E.g.:
				121	#
				122	# `"projects/12345/traceSinks/my-project-trace-sink"`.
				123	#
				124	# Sink identifiers are limited to 256 characters and can include only the
				125	# following characters: upper and lower-case alphanumeric characters,
				126	# underscores, hyphens, and periods.
				127	"outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
				128	"destination": "A String", # The destination for writing trace data. Currently only BigQuery is
				129	# supported. E.g.:
				130	#
				131	# "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
				132	},
				133	"writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is
				134	# set by sinks.create and sinks.update. The service account will need to be
				135	# granted write access to the destination specified in the output
				136	# configuration, see [Granting access for a
				137	# resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource).
				138	# To create tables and write data this account will need the dataEditor role.
				139	# Read more about roles in the [BigQuery
				140	# documentation](https://cloud.google.com/bigquery/docs/access-control).
				141	# E.g.:
				142	#
				143	# "service-00000001@00000002.iam.gserviceaccount.com"
				144	}
				145
				146	x__xgafv: string, V1 error format.
				147	Allowed values
				148	1 - v1 error format
				149	2 - v2 error format
				150
				151	Returns:
				152	An object of the form:
				153
				154	{ # Describes a sink used to export traces to a BigQuery dataset. The sink must
				155	# be created within a project.
				156	"name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the
				157	# form:
				158	#
				159	# project/[PROJECT_NUMBER]/traceSinks/[SINK_ID].
				160	#
				161	# E.g.:
				162	#
				163	# `"projects/12345/traceSinks/my-project-trace-sink"`.
				164	#
				165	# Sink identifiers are limited to 256 characters and can include only the
				166	# following characters: upper and lower-case alphanumeric characters,
				167	# underscores, hyphens, and periods.
				168	"outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
				169	"destination": "A String", # The destination for writing trace data. Currently only BigQuery is
				170	# supported. E.g.:
				171	#
				172	# "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
				173	},
				174	"writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is
				175	# set by sinks.create and sinks.update. The service account will need to be
				176	# granted write access to the destination specified in the output
				177	# configuration, see [Granting access for a
				178	# resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource).
				179	# To create tables and write data this account will need the dataEditor role.
				180	# Read more about roles in the [BigQuery
				181	# documentation](https://cloud.google.com/bigquery/docs/access-control).
				182	# E.g.:
				183	#
				184	# "service-00000001@00000002.iam.gserviceaccount.com"
				185	}</pre>
				186	</div>
				187
				188	<div class="method">
				189	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				190	<pre>Deletes a sink.
				191
				192	Args:
				193	name: string, Required. The full resource name of the sink to delete, including the
				194	parent resource and the sink identifier:
				195
				196	"projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]"
				197
				198	Example: `"projects/12345/traceSinks/my-sink-id"`. (required)
				199	x__xgafv: string, V1 error format.
				200	Allowed values
				201	1 - v1 error format
				202	2 - v2 error format
				203
				204	Returns:
				205	An object of the form:
				206
				207	{ # A generic empty message that you can re-use to avoid defining duplicated
				208	# empty messages in your APIs. A typical example is to use it as the request
				209	# or the response type of an API method. For instance:
				210	#
				211	# service Foo {
				212	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
				213	# }
				214	#
				215	# The JSON representation for `Empty` is empty JSON object `{}`.
				216	}</pre>
				217	</div>
				218
				219	<div class="method">
				220	<code class="details" id="get">get(name, x__xgafv=None)</code>
				221	<pre>Get a trace sink by name under the parent resource (GCP project).
				222
				223	Args:
				224	name: string, Required. The resource name of the sink:
				225
				226	"projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]"
				227
				228	Example: `"projects/12345/traceSinks/my-sink-id"`. (required)
				229	x__xgafv: string, V1 error format.
				230	Allowed values
				231	1 - v1 error format
				232	2 - v2 error format
				233
				234	Returns:
				235	An object of the form:
				236
				237	{ # Describes a sink used to export traces to a BigQuery dataset. The sink must
				238	# be created within a project.
				239	"name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the
				240	# form:
				241	#
				242	# project/[PROJECT_NUMBER]/traceSinks/[SINK_ID].
				243	#
				244	# E.g.:
				245	#
				246	# `"projects/12345/traceSinks/my-project-trace-sink"`.
				247	#
				248	# Sink identifiers are limited to 256 characters and can include only the
				249	# following characters: upper and lower-case alphanumeric characters,
				250	# underscores, hyphens, and periods.
				251	"outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
				252	"destination": "A String", # The destination for writing trace data. Currently only BigQuery is
				253	# supported. E.g.:
				254	#
				255	# "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
				256	},
				257	"writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is
				258	# set by sinks.create and sinks.update. The service account will need to be
				259	# granted write access to the destination specified in the output
				260	# configuration, see [Granting access for a
				261	# resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource).
				262	# To create tables and write data this account will need the dataEditor role.
				263	# Read more about roles in the [BigQuery
				264	# documentation](https://cloud.google.com/bigquery/docs/access-control).
				265	# E.g.:
				266	#
				267	# "service-00000001@00000002.iam.gserviceaccount.com"
				268	}</pre>
				269	</div>
				270
				271	<div class="method">
				272	<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
				273	<pre>List all sinks for the parent resource (GCP project).
				274
				275	Args:
				276	parent: string, Required. The parent resource whose sinks are to be listed (currently only
				277	project parent resources are supported):
				278
				279	"projects/[PROJECT_ID]" (required)
				280	pageToken: string, Optional. If present, then retrieve the next batch of results from the
				281	preceding call to this method. `pageToken` must be the value of
				282	`nextPageToken` from the previous response. The values of other method
				283	parameters should be identical to those in the previous call.
				284	pageSize: integer, Optional. The maximum number of results to return from this request.
				285	Non-positive values are ignored. The presence of `nextPageToken` in the
				286	response indicates that more results might be available.
				287	x__xgafv: string, V1 error format.
				288	Allowed values
				289	1 - v1 error format
				290	2 - v2 error format
				291
				292	Returns:
				293	An object of the form:
				294
				295	{ # Result returned from `ListTraceSinks`.
				296	"sinks": [ # A list of sinks.
				297	{ # Describes a sink used to export traces to a BigQuery dataset. The sink must
				298	# be created within a project.
				299	"name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the
				300	# form:
				301	#
				302	# project/[PROJECT_NUMBER]/traceSinks/[SINK_ID].
				303	#
				304	# E.g.:
				305	#
				306	# `"projects/12345/traceSinks/my-project-trace-sink"`.
				307	#
				308	# Sink identifiers are limited to 256 characters and can include only the
				309	# following characters: upper and lower-case alphanumeric characters,
				310	# underscores, hyphens, and periods.
				311	"outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
				312	"destination": "A String", # The destination for writing trace data. Currently only BigQuery is
				313	# supported. E.g.:
				314	#
				315	# "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
				316	},
				317	"writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is
				318	# set by sinks.create and sinks.update. The service account will need to be
				319	# granted write access to the destination specified in the output
				320	# configuration, see [Granting access for a
				321	# resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource).
				322	# To create tables and write data this account will need the dataEditor role.
				323	# Read more about roles in the [BigQuery
				324	# documentation](https://cloud.google.com/bigquery/docs/access-control).
				325	# E.g.:
				326	#
				327	# "service-00000001@00000002.iam.gserviceaccount.com"
				328	},
				329	],
				330	"nextPageToken": "A String", # If there might be more results than appear in this response, then
				331	# `nextPageToken` is included. To get the next set of results, call the same
				332	# method again using the value of `nextPageToken` as `pageToken`.
				333	}</pre>
				334	</div>
				335
				336	<div class="method">
				337	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				338	<pre>Retrieves the next page of results.
				339
				340	Args:
				341	previous_request: The request for the previous page. (required)
				342	previous_response: The response from the request for the previous page. (required)
				343
				344	Returns:
				345	A request object that you can call 'execute()' on to request the next
				346	page. Returns None if there are no more items in the collection.
				347	</pre>
				348	</div>
				349
				350	<div class="method">
				351	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				352	<pre>Updates a sink. This method updates fields in the existing sink according
				353	to the provided update mask. The sink's name cannot be changed nor any
				354	output-only fields (e.g. the writer_identity).
				355
				356	Args:
				357	name: string, Required. The full resource name of the sink to update, including the
				358	parent resource and the sink identifier:
				359
				360	"projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]"
				361
				362	Example: `"projects/12345/traceSinks/my-sink-id"`. (required)
				363	body: object, The request body.
				364	The object takes the form of:
				365
				366	{ # Describes a sink used to export traces to a BigQuery dataset. The sink must
				367	# be created within a project.
				368	"name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the
				369	# form:
				370	#
				371	# project/[PROJECT_NUMBER]/traceSinks/[SINK_ID].
				372	#
				373	# E.g.:
				374	#
				375	# `"projects/12345/traceSinks/my-project-trace-sink"`.
				376	#
				377	# Sink identifiers are limited to 256 characters and can include only the
				378	# following characters: upper and lower-case alphanumeric characters,
				379	# underscores, hyphens, and periods.
				380	"outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
				381	"destination": "A String", # The destination for writing trace data. Currently only BigQuery is
				382	# supported. E.g.:
				383	#
				384	# "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
				385	},
				386	"writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is
				387	# set by sinks.create and sinks.update. The service account will need to be
				388	# granted write access to the destination specified in the output
				389	# configuration, see [Granting access for a
				390	# resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource).
				391	# To create tables and write data this account will need the dataEditor role.
				392	# Read more about roles in the [BigQuery
				393	# documentation](https://cloud.google.com/bigquery/docs/access-control).
				394	# E.g.:
				395	#
				396	# "service-00000001@00000002.iam.gserviceaccount.com"
				397	}
				398
				399	updateMask: string, Required. Field mask that specifies the fields in `trace_sink` that are to
				400	be updated. A sink field is overwritten if, and only if, it is
				401	in the update mask. `name` and `writer_identity` fields cannot be updated.
				402
				403	An empty updateMask is considered an error.
				404
				405	For a detailed `FieldMask` definition, see
				406	https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
				407
				408	Example: `updateMask=output_config`.
				409	x__xgafv: string, V1 error format.
				410	Allowed values
				411	1 - v1 error format
				412	2 - v2 error format
				413
				414	Returns:
				415	An object of the form:
				416
				417	{ # Describes a sink used to export traces to a BigQuery dataset. The sink must
				418	# be created within a project.
				419	"name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the
				420	# form:
				421	#
				422	# project/[PROJECT_NUMBER]/traceSinks/[SINK_ID].
				423	#
				424	# E.g.:
				425	#
				426	# `"projects/12345/traceSinks/my-project-trace-sink"`.
				427	#
				428	# Sink identifiers are limited to 256 characters and can include only the
				429	# following characters: upper and lower-case alphanumeric characters,
				430	# underscores, hyphens, and periods.
				431	"outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
				432	"destination": "A String", # The destination for writing trace data. Currently only BigQuery is
				433	# supported. E.g.:
				434	#
				435	# "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
				436	},
				437	"writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is
				438	# set by sinks.create and sinks.update. The service account will need to be
				439	# granted write access to the destination specified in the output
				440	# configuration, see [Granting access for a
				441	# resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource).
				442	# To create tables and write data this account will need the dataEditor role.
				443	# Read more about roles in the [BigQuery
				444	# documentation](https://cloud.google.com/bigquery/docs/access-control).
				445	# E.g.:
				446	#
				447	# "service-00000001@00000002.iam.gserviceaccount.com"
				448	}</pre>
				449	</div>
				450
				451	</body></html>