Cloud CDN API, gRPC: RawLogsService
Written by
Updated at April 21, 2023
Call | Description |
---|---|
Activate | |
Deactivate | |
Get | |
Update |
Calls RawLogsService
Activate
rpc Activate (ActivateRawLogsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:ActivateRawLogsMetadata
Operation.response:ActivateRawLogsResponse
ActivateRawLogsRequest
Field | Description |
---|---|
resource_id | string Required. ID of CDN resource to switch logs storage for.. The maximum string length in characters is 50. |
settings | RawLogsSettings Raw logs settings. |
RawLogsSettings
Field | Description |
---|---|
bucket_name | string Required. Destination S3 bucket name, note that the suer should be owner of the bucket. The maximum string length in characters is 1024. |
bucket_region | string Bucket region, unused for now, could be blank. The maximum string length in characters is 50. |
file_prefix | string file_prefix: prefix each log object name with specified prefix. The prefix makes it simpler for you to locate the log objects. For example, if you specify the prefix value logs/, each log object that S3 creates begins with the logs/ prefix in its key, so pseudo S3 folders could be setup. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
ActivateRawLogsMetadata
Field | Description |
---|---|
resource_id | string ID of resource with activated raw logs. |
ActivateRawLogsResponse
Field | Description |
---|---|
status | enum RawLogsStatus Raw logs status.
|
settings | RawLogsSettings Raw logs settings. |
Deactivate
rpc Deactivate (DeactivateRawLogsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeactivateRawLogsMetadata
Operation.response:google.protobuf.Empty
DeactivateRawLogsRequest
Field | Description |
---|---|
resource_id | string Required. ID of CDN resource to deactivate Raw Logs for. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeactivateRawLogsMetadata
Field | Description |
---|---|
resource_id | string ID of CDN resource. |
Get
rpc Get (GetRawLogsRequest) returns (GetRawLogsResponse)
GetRawLogsRequest
Field | Description |
---|---|
resource_id | string Required. ID of CDN resource to request status and settings. The maximum string length in characters is 50. |
GetRawLogsResponse
Field | Description |
---|---|
status | enum RawLogsStatus Raw logs status.
|
settings | RawLogsSettings Raw logs settings. |
RawLogsSettings
Field | Description |
---|---|
bucket_name | string Required. Destination S3 bucket name, note that the suer should be owner of the bucket. The maximum string length in characters is 1024. |
bucket_region | string Bucket region, unused for now, could be blank. The maximum string length in characters is 50. |
file_prefix | string file_prefix: prefix each log object name with specified prefix. The prefix makes it simpler for you to locate the log objects. For example, if you specify the prefix value logs/, each log object that S3 creates begins with the logs/ prefix in its key, so pseudo S3 folders could be setup. The maximum string length in characters is 50. |
Update
rpc Update (UpdateRawLogsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateRawLogsMetadata
Operation.response:UpdateRawLogsResponse
UpdateRawLogsRequest
Field | Description |
---|---|
resource_id | string Required. ID of CDN resource. The maximum string length in characters is 50. |
settings | RawLogsSettings Raw logs settings. |
RawLogsSettings
Field | Description |
---|---|
bucket_name | string Required. Destination S3 bucket name, note that the suer should be owner of the bucket. The maximum string length in characters is 1024. |
bucket_region | string Bucket region, unused for now, could be blank. The maximum string length in characters is 50. |
file_prefix | string file_prefix: prefix each log object name with specified prefix. The prefix makes it simpler for you to locate the log objects. For example, if you specify the prefix value logs/, each log object that S3 creates begins with the logs/ prefix in its key, so pseudo S3 folders could be setup. The maximum string length in characters is 50. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateRawLogsMetadata
Field | Description |
---|---|
resource_id | string ID of CDN resource. |
UpdateRawLogsResponse
Field | Description |
---|---|
status | enum RawLogsStatus Raw logs status.
|
settings | RawLogsSettings Raw logs settings. |