create(parent, body=None, logScopeId=None, x__xgafv=None)

Creates a log scope.

Args:
  parent: string, Required. The parent project in which to create the log scope "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" (required)
  body: object, The request body.
    The object takes the form of:

{ # Describes a group of resources to read log entries from.
  "createTime": "A String", # Output only. The creation timestamp of the log scope.
  "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters.
  "name": "A 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
  "resourceNames": [ # 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.
    "A String",
  ],
  "updateTime": "A String", # Output only. The last update timestamp of the log scope.
}

  logScopeId: string, Required. A client-assigned identifier such as "log-scope". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a group of resources to read log entries from.
  "createTime": "A String", # Output only. The creation timestamp of the log scope.
  "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters.
  "name": "A 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
  "resourceNames": [ # 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.
    "A String",
  ],
  "updateTime": "A String", # Output only. The last update timestamp of the log scope.
}

delete(name, x__xgafv=None)

Deletes a log scope.

Args:
  name: string, Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 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); }
}

get(name, x__xgafv=None)

Gets a log scope.

Args:
  name: string, Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a group of resources to read log entries from.
  "createTime": "A String", # Output only. The creation timestamp of the log scope.
  "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters.
  "name": "A 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
  "resourceNames": [ # 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.
    "A String",
  ],
  "updateTime": "A String", # Output only. The last update timestamp of the log scope.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists log scopes.

Args:
parent: string, Required. The parent resource whose log scopes are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" (required)
pageSize: integer, Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The response from ListLogScopes. Every project has a _Default log scope that cannot be modified or deleted.
"logScopes": [ # A list of log scopes.
{ # Describes a group of resources to read log entries from.
"createTime": "A String", # Output only. The creation timestamp of the log scope.
"description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters.
"name": "A 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
"resourceNames": [ # 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.
"A String",
],
"updateTime": "A String", # Output only. The last update timestamp of the log scope.
},
],
"nextPageToken": "A String", # If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.
}

list_next()

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.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a log scope.

Args:
  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 (required)
  body: object, The request body.
    The object takes the form of:

{ # Describes a group of resources to read log entries from.
  "createTime": "A String", # Output only. The creation timestamp of the log scope.
  "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters.
  "name": "A 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
  "resourceNames": [ # 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.
    "A String",
  ],
  "updateTime": "A String", # Output only. The last update timestamp of the log scope.
}

  updateMask: string, Optional. Field mask that specifies the fields in log_scope that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=description
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes a group of resources to read log entries from.
  "createTime": "A String", # Output only. The creation timestamp of the log scope.
  "description": "A String", # Optional. Describes this log scope.The maximum length of the description is 8000 characters.
  "name": "A 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
  "resourceNames": [ # 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.
    "A String",
  ],
  "updateTime": "A String", # Output only. The last update timestamp of the log scope.
}

Cloud Logging API . organizations . locations . logScopes

Instance Methods

Method Details