docs/dyn/logging_v1beta3.projects.logs.html - platform/external/python/google-api-python-client - Gitiles

 <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="logging_v1beta3.html">Google Cloud Logging API</a> . <a href="logging_v1beta3.projects.html">projects</a> . <a href="logging_v1beta3.projects.logs.html">logs</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="logging_v1beta3.projects.logs.entries.html">entries()</a></code>
 </p>
 <p class="firstline">Returns the entries Resource.</p>

 <p class="toc_element">
   <code><a href="logging_v1beta3.projects.logs.sinks.html">sinks()</a></code>
 </p>
 <p class="firstline">Returns the sinks Resource.</p>

 <p class="toc_element">
   <code><a href="#delete">delete(projectsId, logsId, x__xgafv=None)</a></code></p>
 <p class="firstline">Deletes the specified log resource and all log entries contained in it.</p>
 <p class="toc_element">
   <code><a href="#list">list(projectsId, pageSize=None, serviceName=None, pageToken=None, x__xgafv=None, serviceIndexPrefix=None)</a></code></p>
 <p class="firstline">Lists log resources belonging to the specified project.</p>
 <p class="toc_element">
   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
 <p class="firstline">Retrieves the next page of results.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="delete">delete(projectsId, logsId, x__xgafv=None)</code>
   <pre>Deletes the specified log resource and all log entries contained in it.

 Args:
   projectsId: string, Part of `logName`. The log resource to delete. (required)
   logsId: string, Part of `logName`. See documentation of `projectsId`. (required)
   x__xgafv: string, V1 error format.

 Returns:
   An object of the form:

     { # 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); }
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(projectsId, pageSize=None, serviceName=None, pageToken=None, x__xgafv=None, serviceIndexPrefix=None)</code>
   <pre>Lists log resources belonging to the specified project.

 Args:
   projectsId: string, Part of `projectName`. The project name for which to list the log resources. (required)
   pageSize: integer, The maximum number of results to return.
   serviceName: string, A service name for which to list logs. Only logs containing entries whose metadata includes this service name are returned. If `serviceName` and `serviceIndexPrefix` are both empty, then all log names are returned. To list all log names, regardless of service, leave both the `serviceName` and `serviceIndexPrefix` empty. To list log names containing entries with a particular service name (or explicitly empty service name) set `serviceName` to the desired value and `serviceIndexPrefix` to `"/"`.
   pageToken: string, An opaque token, returned as `nextPageToken` by a prior `ListLogs` operation. If `pageToken` is supplied, then the other fields of this request are ignored, and instead the previous `ListLogs` operation is continued.
   x__xgafv: string, V1 error format.
   serviceIndexPrefix: string, A log service index prefix for which to list logs. Only logs containing entries whose metadata that includes these label values (associated with index keys) are returned. The prefix is a slash separated list of values, and need not specify all index labels. An empty index (or a single slash) matches all log service indexes.

 Returns:
   An object of the form:

     { # Result returned from ListLogs.
     "nextPageToken": "A String", # If there are more results, then `nextPageToken` is returned in the response. To get the next batch of logs, use the value of `nextPageToken` as `pageToken` in the next call of `ListLogs`. If `nextPageToken` is empty, then there are no more results.
     "logs": [ # A list of log resources.
       { # A log object.
         "payloadType": "A String", # Type URL describing the expected payload type for the log.
         "displayName": "A String", # Name used when displaying the log to the user (for example, in a UI). Example: `"activity_log"`
         "name": "A String", # REQUIRED: The log's name name. Example: `"compute.googleapis.com/activity_log"`.
       },
     ],
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list_next">list_next(previous_request, previous_response)</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>

 </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="logging_v1beta3.html">Google Cloud Logging API</a> . <a href="logging_v1beta3.projects.html">projects</a> . <a href="logging_v1beta3.projects.logs.html">logs</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="logging_v1beta3.projects.logs.entries.html">entries()</a></code>
	</p>
	<p class="firstline">Returns the entries Resource.</p>

	<p class="toc_element">
	<code><a href="logging_v1beta3.projects.logs.sinks.html">sinks()</a></code>
	</p>
	<p class="firstline">Returns the sinks Resource.</p>

	<p class="toc_element">
	<code><a href="#delete">delete(projectsId, logsId, x__xgafv=None)</a></code></p>
	<p class="firstline">Deletes the specified log resource and all log entries contained in it.</p>
	<p class="toc_element">
	<code><a href="#list">list(projectsId, pageSize=None, serviceName=None, pageToken=None, x__xgafv=None, serviceIndexPrefix=None)</a></code></p>
	<p class="firstline">Lists log resources belonging to the specified project.</p>
	<p class="toc_element">
	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
	<p class="firstline">Retrieves the next page of results.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="delete">delete(projectsId, logsId, x__xgafv=None)</code>
	<pre>Deletes the specified log resource and all log entries contained in it.

	Args:
	projectsId: string, Part of `logName`. The log resource to delete. (required)
	logsId: string, Part of `logName`. See documentation of `projectsId`. (required)
	x__xgafv: string, V1 error format.

	Returns:
	An object of the form:

	{ # 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); }
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(projectsId, pageSize=None, serviceName=None, pageToken=None, x__xgafv=None, serviceIndexPrefix=None)</code>
	<pre>Lists log resources belonging to the specified project.

	Args:
	projectsId: string, Part of `projectName`. The project name for which to list the log resources. (required)
	pageSize: integer, The maximum number of results to return.
	serviceName: string, A service name for which to list logs. Only logs containing entries whose metadata includes this service name are returned. If `serviceName` and `serviceIndexPrefix` are both empty, then all log names are returned. To list all log names, regardless of service, leave both the `serviceName` and `serviceIndexPrefix` empty. To list log names containing entries with a particular service name (or explicitly empty service name) set `serviceName` to the desired value and `serviceIndexPrefix` to `"/"`.
	pageToken: string, An opaque token, returned as `nextPageToken` by a prior `ListLogs` operation. If `pageToken` is supplied, then the other fields of this request are ignored, and instead the previous `ListLogs` operation is continued.
	x__xgafv: string, V1 error format.
	serviceIndexPrefix: string, A log service index prefix for which to list logs. Only logs containing entries whose metadata that includes these label values (associated with index keys) are returned. The prefix is a slash separated list of values, and need not specify all index labels. An empty index (or a single slash) matches all log service indexes.

	Returns:
	An object of the form:

	{ # Result returned from ListLogs.
	"nextPageToken": "A String", # If there are more results, then `nextPageToken` is returned in the response. To get the next batch of logs, use the value of `nextPageToken` as `pageToken` in the next call of `ListLogs`. If `nextPageToken` is empty, then there are no more results.
	"logs": [ # A list of log resources.
	{ # A log object.
	"payloadType": "A String", # Type URL describing the expected payload type for the log.
	"displayName": "A String", # Name used when displaying the log to the user (for example, in a UI). Example: `"activity_log"`
	"name": "A String", # REQUIRED: The log's name name. Example: `"compute.googleapis.com/activity_log"`.
	},
	],
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list_next">list_next(previous_request, previous_response)</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>

	</body></html>