You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pre>Exports data from the cluster. Imperative only.
534
+
535
+
Args:
536
+
name: string, Required. The resource name of the cluster. (required)
537
+
body: object, The request body.
538
+
The object takes the form of:
539
+
540
+
{ # Export cluster request.
541
+
"csvExportOptions": { # Options for exporting data in CSV format. For now, we only support a query to get the data that needs to be exported. # Options for exporting data in CSV format. Required field to be set for CSV file type.
542
+
"selectQuery": "A String", # Required. The select_query used to extract the data.
543
+
},
544
+
"database": "A String", # Required. Name of the database where the query will be executed. Note - Value provided should be the same as expected from `SELECT current_database();` and NOT as a resource reference.
545
+
"gcsDestination": { # Destination for Export. Export will be done to cloud storage. # Required. Option to export data to cloud storage.
546
+
"uri": "A String", # Required. The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails.
547
+
},
548
+
}
549
+
550
+
x__xgafv: string, V1 error format.
551
+
Allowed values
552
+
1 - v1 error format
553
+
2 - v2 error format
554
+
555
+
Returns:
556
+
An object of the form:
557
+
558
+
{ # This resource represents a long-running operation that is the result of a network API call.
559
+
"done": True or False, # 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.
560
+
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
561
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
562
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
563
+
{
564
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
565
+
},
566
+
],
567
+
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
568
+
},
569
+
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
570
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
571
+
},
572
+
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
573
+
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
574
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
<pre>Exports data from the cluster. Imperative only.
554
+
555
+
Args:
556
+
name: string, Required. The resource name of the cluster. (required)
557
+
body: object, The request body.
558
+
The object takes the form of:
559
+
560
+
{ # Export cluster request.
561
+
"csvExportOptions": { # Options for exporting data in CSV format. For now, we only support a query to get the data that needs to be exported. # Options for exporting data in CSV format. Required field to be set for CSV file type.
562
+
"escapeCharacter": "A String", # Optional. Specifies the character that should appear before a data character that needs to be escaped. The default is the same as quote character. The value of this argument has to be a character in Hex ASCII Code.
563
+
"fieldDelimiter": "A String", # Optional. Specifies the character that separates columns within each row (line) of the file. The default is comma. The value of this argument has to be a character in Hex ASCII Code.
564
+
"quoteCharacter": "A String", # Optional. Specifies the quoting character to be used when a data value is quoted. The default is double-quote. The value of this argument has to be a character in Hex ASCII Code.
565
+
"selectQuery": "A String", # Required. The select_query used to extract the data.
566
+
},
567
+
"database": "A String", # Required. Name of the database where the query will be executed. Note - Value provided should be the same as expected from `SELECT current_database();` and NOT as a resource reference.
568
+
"gcsDestination": { # Destination for Export. Export will be done to cloud storage. # Required. Option to export data to cloud storage.
569
+
"uri": "A String", # Required. The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails.
570
+
},
571
+
"sqlExportOptions": { # Options for exporting data in SQL format. # Options for exporting data in SQL format. Required field to be set for SQL file type.
572
+
"cleanTargetObjects": True or False, # Optional. If true, output commands to DROP all the dumped database objects prior to outputting the commands for creating them.
573
+
"ifExistTargetObjects": True or False, # Optional. If true, use DROP ... IF EXISTS commands to check for the object's existence before dropping it in clean_target_objects mode.
574
+
"schemaOnly": True or False, # Optional. If true, only export the schema.
575
+
"tables": [ # Optional. Tables to export from.
576
+
"A String",
577
+
],
578
+
},
579
+
}
580
+
581
+
x__xgafv: string, V1 error format.
582
+
Allowed values
583
+
1 - v1 error format
584
+
2 - v2 error format
585
+
586
+
Returns:
587
+
An object of the form:
588
+
589
+
{ # This resource represents a long-running operation that is the result of a network API call.
590
+
"done": True or False, # 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.
591
+
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
592
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
593
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
594
+
{
595
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
596
+
},
597
+
],
598
+
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
599
+
},
600
+
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
601
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
602
+
},
603
+
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
604
+
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
605
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
<pre>Exports data from the cluster. Imperative only.
550
+
551
+
Args:
552
+
name: string, Required. The resource name of the cluster. (required)
553
+
body: object, The request body.
554
+
The object takes the form of:
555
+
556
+
{ # Export cluster request.
557
+
"csvExportOptions": { # Options for exporting data in CSV format. For now, we only support a query to get the data that needs to be exported. # Options for exporting data in CSV format. Required field to be set for CSV file type.
558
+
"escapeCharacter": "A String", # Optional. Specifies the character that should appear before a data character that needs to be escaped. The default is the same as quote character. The value of this argument has to be a character in Hex ASCII Code.
559
+
"fieldDelimiter": "A String", # Optional. Specifies the character that separates columns within each row (line) of the file. The default is comma. The value of this argument has to be a character in Hex ASCII Code.
560
+
"quoteCharacter": "A String", # Optional. Specifies the quoting character to be used when a data value is quoted. The default is double-quote. The value of this argument has to be a character in Hex ASCII Code.
561
+
"selectQuery": "A String", # Required. The select_query used to extract the data.
562
+
},
563
+
"database": "A String", # Required. Name of the database where the query will be executed. Note - Value provided should be the same as expected from `SELECT current_database();` and NOT as a resource reference.
564
+
"gcsDestination": { # Destination for Export. Export will be done to cloud storage. # Required. Option to export data to cloud storage.
565
+
"uri": "A String", # Required. The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails.
566
+
},
567
+
"sqlExportOptions": { # Options for exporting data in SQL format. # Options for exporting data in SQL format. Required field to be set for SQL file type.
568
+
"cleanTargetObjects": True or False, # Optional. If true, output commands to DROP all the dumped database objects prior to outputting the commands for creating them.
569
+
"ifExistTargetObjects": True or False, # Optional. If true, use DROP ... IF EXISTS commands to check for the object's existence before dropping it in clean_target_objects mode.
570
+
"schemaOnly": True or False, # Optional. If true, only export the schema.
571
+
"tables": [ # Optional. Tables to export from.
572
+
"A String",
573
+
],
574
+
},
575
+
}
576
+
577
+
x__xgafv: string, V1 error format.
578
+
Allowed values
579
+
1 - v1 error format
580
+
2 - v2 error format
581
+
582
+
Returns:
583
+
An object of the form:
584
+
585
+
{ # This resource represents a long-running operation that is the result of a network API call.
586
+
"done": True or False, # 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.
587
+
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
588
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
589
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
590
+
{
591
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
592
+
},
593
+
],
594
+
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
595
+
},
596
+
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
597
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
598
+
},
599
+
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
600
+
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
601
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
0 commit comments