log_scopes

Creates, updates, deletes, gets or lists a log_scopes resource.

Overview

Name	log_scopes
Type	Resource
Id	google.logging.log_scopes

Fields

The following fields are returned by SELECT queries:

projects_locations_log_scopes_get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope
createTime	string (google-datetime)	Output only. The creation timestamp of the log scope.
description	string	Optional. Describes this log scope.The maximum length of the description is 8000 characters.
resourceNames	array	Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total.
updateTime	string (google-datetime)	Output only. The last update timestamp of the log scope.

organizations_locations_log_scopes_get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope
createTime	string (google-datetime)	Output only. The creation timestamp of the log scope.
description	string	Optional. Describes this log scope.The maximum length of the description is 8000 characters.
resourceNames	array	Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total.
updateTime	string (google-datetime)	Output only. The last update timestamp of the log scope.

folders_locations_log_scopes_get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope
createTime	string (google-datetime)	Output only. The creation timestamp of the log scope.
description	string	Optional. Describes this log scope.The maximum length of the description is 8000 characters.
resourceNames	array	Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total.
updateTime	string (google-datetime)	Output only. The last update timestamp of the log scope.

projects_locations_log_scopes_list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope
createTime	string (google-datetime)	Output only. The creation timestamp of the log scope.
description	string	Optional. Describes this log scope.The maximum length of the description is 8000 characters.
resourceNames	array	Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total.
updateTime	string (google-datetime)	Output only. The last update timestamp of the log scope.

organizations_locations_log_scopes_list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope
createTime	string (google-datetime)	Output only. The creation timestamp of the log scope.
description	string	Optional. Describes this log scope.The maximum length of the description is 8000 characters.
resourceNames	array	Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total.
updateTime	string (google-datetime)	Output only. The last update timestamp of the log scope.

folders_locations_log_scopes_list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my-project/locations/global/logScopes/my-log-scope
createTime	string (google-datetime)	Output only. The creation timestamp of the log scope.
description	string	Optional. Describes this log scope.The maximum length of the description is 8000 characters.
resourceNames	array	Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total.
updateTime	string (google-datetime)	Output only. The last update timestamp of the log scope.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_log_scopes_get	select	projectsId, locationsId, logScopesId		Gets a log scope.
organizations_locations_log_scopes_get	select	organizationsId, locationsId, logScopesId		Gets a log scope.
folders_locations_log_scopes_get	select	foldersId, locationsId, logScopesId		Gets a log scope.
projects_locations_log_scopes_list	select	projectsId, locationsId	pageToken, pageSize	Lists log scopes.
organizations_locations_log_scopes_list	select	organizationsId, locationsId	pageToken, pageSize	Lists log scopes.
folders_locations_log_scopes_list	select	foldersId, locationsId	pageToken, pageSize	Lists log scopes.
projects_locations_log_scopes_create	insert	projectsId, locationsId	logScopeId	Creates a log scope.
organizations_locations_log_scopes_create	insert	organizationsId, locationsId	logScopeId	Creates a log scope.
folders_locations_log_scopes_create	insert	foldersId, locationsId	logScopeId	Creates a log scope.
projects_locations_log_scopes_patch	update	projectsId, locationsId, logScopesId	updateMask	Updates a log scope.
organizations_locations_log_scopes_patch	update	organizationsId, locationsId, logScopesId	updateMask	Updates a log scope.
folders_locations_log_scopes_patch	update	foldersId, locationsId, logScopesId	updateMask	Updates a log scope.
projects_locations_log_scopes_delete	delete	projectsId, locationsId, logScopesId		Deletes a log scope.
organizations_locations_log_scopes_delete	delete	organizationsId, locationsId, logScopesId		Deletes a log scope.
folders_locations_log_scopes_delete	delete	foldersId, locationsId, logScopesId		Deletes a log scope.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
foldersId	string
locationsId	string
logScopesId	string
organizationsId	string
projectsId	string
logScopeId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_log_scopes_get

Gets a log scope.

SELECT
name,
createTime,
description,
resourceNames,
updateTime
FROM google.logging.log_scopes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND logScopesId = '{{ logScopesId }}' -- required;

organizations_locations_log_scopes_get

Gets a log scope.

SELECT
name,
createTime,
description,
resourceNames,
updateTime
FROM google.logging.log_scopes
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND logScopesId = '{{ logScopesId }}' -- required;

folders_locations_log_scopes_get

Gets a log scope.

SELECT
name,
createTime,
description,
resourceNames,
updateTime
FROM google.logging.log_scopes
WHERE foldersId = '{{ foldersId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND logScopesId = '{{ logScopesId }}' -- required;

projects_locations_log_scopes_list

Lists log scopes.

SELECT
name,
createTime,
description,
resourceNames,
updateTime
FROM google.logging.log_scopes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

organizations_locations_log_scopes_list

Lists log scopes.

SELECT
name,
createTime,
description,
resourceNames,
updateTime
FROM google.logging.log_scopes
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

folders_locations_log_scopes_list

Lists log scopes.

SELECT
name,
createTime,
description,
resourceNames,
updateTime
FROM google.logging.log_scopes
WHERE foldersId = '{{ foldersId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

INSERT examples

projects_locations_log_scopes_create

Creates a log scope.

INSERT INTO google.logging.log_scopes (
data__resourceNames,
data__description,
projectsId,
locationsId,
logScopeId
)
SELECT 
'{{ resourceNames }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ logScopeId }}'
RETURNING
name,
createTime,
description,
resourceNames,
updateTime
;

organizations_locations_log_scopes_create

Creates a log scope.

INSERT INTO google.logging.log_scopes (
data__resourceNames,
data__description,
organizationsId,
locationsId,
logScopeId
)
SELECT 
'{{ resourceNames }}',
'{{ description }}',
'{{ organizationsId }}',
'{{ locationsId }}',
'{{ logScopeId }}'
RETURNING
name,
createTime,
description,
resourceNames,
updateTime
;

folders_locations_log_scopes_create

Creates a log scope.

INSERT INTO google.logging.log_scopes (
data__resourceNames,
data__description,
foldersId,
locationsId,
logScopeId
)
SELECT 
'{{ resourceNames }}',
'{{ description }}',
'{{ foldersId }}',
'{{ locationsId }}',
'{{ logScopeId }}'
RETURNING
name,
createTime,
description,
resourceNames,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: log_scopes
  props:
    - name: projectsId
      value: string
      description: Required parameter for the log_scopes resource.
    - name: locationsId
      value: string
      description: Required parameter for the log_scopes resource.
    - name: organizationsId
      value: string
      description: Required parameter for the log_scopes resource.
    - name: foldersId
      value: string
      description: Required parameter for the log_scopes resource.
    - name: resourceNames
      value: array
      description: >
        Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total.
        
    - name: description
      value: string
      description: >
        Optional. Describes this log scope.The maximum length of the description is 8000 characters.
        
    - name: logScopeId
      value: string

UPDATE examples

projects_locations_log_scopes_patch

Updates a log scope.

UPDATE google.logging.log_scopes
SET 
data__resourceNames = '{{ resourceNames }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND logScopesId = '{{ logScopesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
resourceNames,
updateTime;

organizations_locations_log_scopes_patch

Updates a log scope.

UPDATE google.logging.log_scopes
SET 
data__resourceNames = '{{ resourceNames }}',
data__description = '{{ description }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND logScopesId = '{{ logScopesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
resourceNames,
updateTime;

folders_locations_log_scopes_patch

Updates a log scope.

UPDATE google.logging.log_scopes
SET 
data__resourceNames = '{{ resourceNames }}',
data__description = '{{ description }}'
WHERE 
foldersId = '{{ foldersId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND logScopesId = '{{ logScopesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
resourceNames,
updateTime;

DELETE examples

projects_locations_log_scopes_delete

Deletes a log scope.

DELETE FROM google.logging.log_scopes
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND logScopesId = '{{ logScopesId }}' --required;

organizations_locations_log_scopes_delete

Deletes a log scope.

DELETE FROM google.logging.log_scopes
WHERE organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND logScopesId = '{{ logScopesId }}' --required;

folders_locations_log_scopes_delete

Deletes a log scope.

DELETE FROM google.logging.log_scopes
WHERE foldersId = '{{ foldersId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND logScopesId = '{{ logScopesId }}' --required;