diff --git a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/analyze.proto b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/analyze.proto index 6f987fafad0..ece76eb5a93 100644 --- a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/analyze.proto +++ b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/analyze.proto @@ -42,7 +42,8 @@ message Environment { // Optional. Size in GB of the disk. Default is 100 GB. int32 disk_size_gb = 1 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Total number of nodes in the sessions created for this environment. + // Optional. Total number of nodes in the sessions created for this + // environment. int32 node_count = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. Max configurable nodes. @@ -58,18 +59,21 @@ message Environment { // Optional. List of Java jars to be included in the runtime environment. // Valid input includes Cloud Storage URIs to Jar binaries. // For example, gs://bucket-name/my/path/to/file.jar - repeated string java_libraries = 2 [(google.api.field_behavior) = OPTIONAL]; + repeated string java_libraries = 2 + [(google.api.field_behavior) = OPTIONAL]; // Optional. A list of python packages to be installed. // Valid formats include Cloud Storage URI to a PIP installable library. // For example, gs://bucket-name/my/path/to/lib.tar.gz - repeated string python_packages = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Spark properties to provide configuration for use in sessions created - // for this environment. The properties to set on daemon config files. - // Property keys are specified in `prefix:property` format. - // The prefix must be "spark". - map properties = 4 [(google.api.field_behavior) = OPTIONAL]; + repeated string python_packages = 3 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Spark properties to provide configuration for use in sessions + // created for this environment. The properties to set on daemon config + // files. Property keys are specified in `prefix:property` format. The + // prefix must be "spark". + map properties = 4 + [(google.api.field_behavior) = OPTIONAL]; } // Hardware config @@ -80,7 +84,8 @@ message Environment { // Software config oneof runtime { - // Required. Software Runtime Configuration for analyze interactive workloads. + // Required. Software Runtime Configuration for analyze interactive + // workloads. OsImageRuntime os_image = 100 [(google.api.field_behavior) = REQUIRED]; } } @@ -88,19 +93,20 @@ message Environment { message SessionSpec { // Optional. The idle time configuration of the session. The session will be // auto-terminated at the end of this period. - google.protobuf.Duration max_idle_duration = 1 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. If True, this causes sessions to be pre-created and available for faster - // startup to enable interactive exploration use-cases. This defaults to - // False to avoid additional billed charges. - // These can only be set to True for the environment with name set to - // "default", and with default configuration. + google.protobuf.Duration max_idle_duration = 1 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. If True, this causes sessions to be pre-created and available + // for faster startup to enable interactive exploration use-cases. This + // defaults to False to avoid additional billed charges. These can only be + // set to True for the environment with name set to "default", and with + // default configuration. bool enable_fast_startup = 2 [(google.api.field_behavior) = OPTIONAL]; } message SessionStatus { - // Output only. Queries over sessions to mark whether the environment is currently - // active or not + // Output only. Queries over sessions to mark whether the environment is + // currently active or not bool active = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; } @@ -124,15 +130,18 @@ message Environment { // Optional. User friendly display name. string display_name = 2 [(google.api.field_behavior) = OPTIONAL]; - // Output only. System generated globally unique ID for the environment. This ID will be - // different if the environment is deleted and re-created with the same name. + // Output only. System generated globally unique ID for the environment. This + // ID will be different if the environment is deleted and re-created with the + // same name. string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Environment creation time. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the environment was last updated. - google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. User defined labels for the environment. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; @@ -144,15 +153,18 @@ message Environment { State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. Infrastructure specification for the Environment. - InfrastructureSpec infrastructure_spec = 100 [(google.api.field_behavior) = REQUIRED]; + InfrastructureSpec infrastructure_spec = 100 + [(google.api.field_behavior) = REQUIRED]; // Optional. Configuration for sessions created for this environment. SessionSpec session_spec = 101 [(google.api.field_behavior) = OPTIONAL]; // Output only. Status of sessions created for this environment. - SessionStatus session_status = 102 [(google.api.field_behavior) = OUTPUT_ONLY]; + SessionStatus session_status = 102 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. URI Endpoints to access sessions associated with the Environment. + // Output only. URI Endpoints to access sessions associated with the + // Environment. Endpoints endpoints = 200 [(google.api.field_behavior) = OUTPUT_ONLY]; } @@ -202,20 +214,23 @@ message Content { } ]; - // Output only. System generated globally unique ID for the content. This ID will be - // different if the content is deleted and re-created with the same name. + // Output only. System generated globally unique ID for the content. This ID + // will be different if the content is deleted and re-created with the same + // name. string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Required. The path for the Content file, represented as directory structure. - // Unique within a lake. - // Limited to alphanumerics, hyphens, underscores, dots and slashes. + // Required. The path for the Content file, represented as directory + // structure. Unique within a lake. Limited to alphanumerics, hyphens, + // underscores, dots and slashes. string path = 3 [(google.api.field_behavior) = REQUIRED]; // Output only. Content creation time. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the content was last updated. - google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. User defined labels for the content. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; @@ -258,7 +273,8 @@ message Session { string user_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Session start time. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } diff --git a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/content.proto b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/content.proto index cd335a58cfd..9064de5c32a 100644 --- a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/content.proto +++ b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/content.proto @@ -34,7 +34,8 @@ option java_package = "com.google.cloud.dataplex.v1"; // ContentService manages Notebook and SQL Scripts for Dataplex. service ContentService { option (google.api.default_host) = "dataplex.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Create a content. rpc CreateContent(CreateContentRequest) returns (Content) { @@ -90,7 +91,8 @@ service ContentService { // // Caller must have Google IAM `dataplex.content.getIamPolicy` permission // on the resource. - rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) { + rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) + returns (google.iam.v1.Policy) { option (google.api.http) = { get: "/v1/{resource=projects/*/locations/*/lakes/*/contentitems/**}:getIamPolicy" additional_bindings { @@ -105,7 +107,8 @@ service ContentService { // // Caller must have Google IAM `dataplex.content.setIamPolicy` permission // on the resource. - rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) { + rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) + returns (google.iam.v1.Policy) { option (google.api.http) = { post: "/v1/{resource=projects/*/locations/*/lakes/*/contentitems/**}:setIamPolicy" body: "*" @@ -126,7 +129,8 @@ service ContentService { // Note: This operation is designed to be used for building permission-aware // UIs and command-line tools, not for authorization checking. This operation // may "fail open" without warning. - rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) { + rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) + returns (google.iam.v1.TestIamPermissionsResponse) { option (google.api.http) = { post: "/v1/{resource=projects/*/locations/*/lakes/*/contentitems/**}:testIamPermissions" body: "*" @@ -155,9 +159,7 @@ message CreateContentRequest { // projects/{project_id}/locations/{location_id}/lakes/{lake_id} string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; // Required. Content resource. @@ -171,7 +173,8 @@ message CreateContentRequest { // Update content request. message UpdateContentRequest { // Required. Mask of fields to update. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Update description. // Only fields specified in `update_mask` are updated. @@ -200,18 +203,16 @@ message ListContentRequest { // projects/{project_id}/locations/{location_id}/lakes/{lake_id} string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; - // Optional. Maximum number of content to return. The service may return fewer than - // this value. If unspecified, at most 10 content will be returned. The + // Optional. Maximum number of content to return. The service may return fewer + // than this value. If unspecified, at most 10 content will be returned. The // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListContent` call. Provide this - // to retrieve the subsequent page. When paginating, all other parameters + // Optional. Page token received from a previous `ListContent` call. Provide + // this to retrieve the subsequent page. When paginating, all other parameters // provided to `ListContent` must match the call that provided the page // token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; diff --git a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/metadata.proto b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/metadata.proto index 290d9406628..5aac7eb1406 100644 --- a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/metadata.proto +++ b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/metadata.proto @@ -32,7 +32,8 @@ option java_package = "com.google.cloud.dataplex.v1"; // partitions. service MetadataService { option (google.api.default_host) = "dataplex.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Create a metadata entity. rpc CreateEntity(CreateEntityRequest) returns (Entity) { @@ -115,9 +116,7 @@ message CreateEntityRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; // Required. Entity resource. @@ -147,13 +146,11 @@ message DeleteEntityRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Entity" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Entity" } ]; - // Required. The etag associated with the entity, which can be retrieved with a - // [GetEntity][] request. + // Required. The etag associated with the entity, which can be retrieved with + // a [GetEntity][] request. string etag = 2 [(google.api.field_behavior) = REQUIRED]; } @@ -176,17 +173,16 @@ message ListEntitiesRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; // Required. Specify the entity view to make a partial list request. EntityView view = 2 [(google.api.field_behavior) = REQUIRED]; - // Optional. Maximum number of entities to return. The service may return fewer than - // this value. If unspecified, 100 entities will be returned by default. The - // maximum value is 500; larger values will will be truncated to 500. + // Optional. Maximum number of entities to return. The service may return + // fewer than this value. If unspecified, 100 entities will be returned by + // default. The maximum value is 500; larger values will will be truncated to + // 500. int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. Page token received from a previous `ListEntities` call. Provide @@ -195,8 +191,8 @@ message ListEntitiesRequest { // page token. string page_token = 4 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The following filter parameters can be added to the URL to limit the - // entities returned by the API: + // Optional. The following filter parameters can be added to the URL to limit + // the entities returned by the API: // // - Entity ID: ?filter="id=entityID" // - Asset ID: ?filter="asset=assetID" @@ -237,9 +233,7 @@ message GetEntityRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.` string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Entity" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Entity" } ]; // Optional. Used to select the subset of entity information to return. @@ -253,24 +247,23 @@ message ListPartitionsRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Entity" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Entity" } ]; - // Optional. Maximum number of partitions to return. The service may return fewer than - // this value. If unspecified, 100 partitions will be returned by default. The - // maximum page size is 500; larger values will will be truncated to 500. + // Optional. Maximum number of partitions to return. The service may return + // fewer than this value. If unspecified, 100 partitions will be returned by + // default. The maximum page size is 500; larger values will will be truncated + // to 500. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListPartitions` call. Provide - // this to retrieve the subsequent page. When paginating, all other parameters - // provided to `ListPartitions` must match the call that provided the - // page token. + // Optional. Page token received from a previous `ListPartitions` call. + // Provide this to retrieve the subsequent page. When paginating, all other + // parameters provided to `ListPartitions` must match the call that provided + // the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Filter the partitions returned to the caller using a key value pair - // expression. Supported operators and syntax: + // Optional. Filter the partitions returned to the caller using a key value + // pair expression. Supported operators and syntax: // // - logic operators: AND, OR // - comparison operators: <, >, >=, <= ,=, != @@ -297,9 +290,7 @@ message CreatePartitionRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Entity" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Entity" } ]; // Required. Partition resource. @@ -325,10 +316,7 @@ message DeletePartitionRequest { ]; // Optional. The etag associated with the partition. - string etag = 2 [ - deprecated = true, - (google.api.field_behavior) = OPTIONAL - ]; + string etag = 2 [deprecated = true, (google.api.field_behavior) = OPTIONAL]; } // List metadata partitions response. @@ -378,17 +366,18 @@ message Entity { message CompatibilityStatus { // Provides compatibility information for a specific metadata store. message Compatibility { - // Output only. Whether the entity is compatible and can be represented in the metadata - // store. + // Output only. Whether the entity is compatible and can be represented in + // the metadata store. bool compatible = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Provides additional detail if the entity is incompatible with the - // metadata store. + // Output only. Provides additional detail if the entity is incompatible + // with the metadata store. string reason = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; } // Output only. Whether this entity is compatible with Hive Metastore. - Compatibility hive_metastore = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + Compatibility hive_metastore = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Whether this entity is compatible with BigQuery. Compatibility bigquery = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -398,23 +387,23 @@ message Entity { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}`. string name = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Entity" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Entity" } ]; // Optional. Display name must be shorter than or equal to 256 characters. string display_name = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. User friendly longer description text. Must be shorter than or equal to - // 1024 characters. + // Optional. User friendly longer description text. Must be shorter than or + // equal to 1024 characters. string description = 3 [(google.api.field_behavior) = OPTIONAL]; // Output only. The time when the entity was created. - google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the entity was last updated. - google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 6 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. A user-provided entity ID. It is mutable, and will be used as the // published table name. Specifying a new ID in an update entity @@ -424,8 +413,8 @@ message Entity { // characters. string id = 7 [(google.api.field_behavior) = REQUIRED]; - // Optional. The etag associated with the entity, which can be retrieved with a - // [GetEntity][] request. Required for update and delete requests. + // Optional. The etag associated with the entity, which can be retrieved with + // a [GetEntity][] request. Required for update and delete requests. string etag = 8 [(google.api.field_behavior) = OPTIONAL]; // Required. Immutable. The type of entity. @@ -434,8 +423,9 @@ message Entity { (google.api.field_behavior) = IMMUTABLE ]; - // Required. Immutable. The ID of the asset associated with the storage location containing the - // entity data. The entity must be with in the same zone with the asset. + // Required. Immutable. The ID of the asset associated with the storage + // location containing the entity data. The entity must be with in the same + // zone with the asset. string asset = 11 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE @@ -451,9 +441,9 @@ message Entity { (google.api.field_behavior) = IMMUTABLE ]; - // Optional. The set of items within the data path constituting the data in the entity, - // represented as a glob path. - // Example: `gs://bucket/path/to/data/**/*.csv`. + // Optional. The set of items within the data path constituting the data in + // the entity, represented as a glob path. Example: + // `gs://bucket/path/to/data/**/*.csv`. string data_path_pattern = 13 [(google.api.field_behavior) = OPTIONAL]; // Output only. The name of the associated Data Catalog entry. @@ -470,7 +460,8 @@ message Entity { StorageFormat format = 16 [(google.api.field_behavior) = REQUIRED]; // Output only. Metadata stores that the entity is compatible with. - CompatibilityStatus compatibility = 19 [(google.api.field_behavior) = OUTPUT_ONLY]; + CompatibilityStatus compatibility = 19 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Required. The description of the data structure and layout. // The schema is not included in list responses. It is only included in @@ -497,26 +488,23 @@ message Partition { } ]; - // Required. Immutable. The set of values representing the partition, which correspond to the - // partition schema defined in the parent entity. + // Required. Immutable. The set of values representing the partition, which + // correspond to the partition schema defined in the parent entity. repeated string values = 2 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE ]; - // Required. Immutable. The location of the entity data within the partition, for example, - // `gs://bucket/path/to/entity/key1=value1/key2=value2`. - // Or `projects//datasets//tables/` + // Required. Immutable. The location of the entity data within the partition, + // for example, `gs://bucket/path/to/entity/key1=value1/key2=value2`. Or + // `projects//datasets//tables/` string location = 3 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE ]; // Optional. The etag for this partition. - string etag = 4 [ - deprecated = true, - (google.api.field_behavior) = OPTIONAL - ]; + string etag = 4 [deprecated = true, (google.api.field_behavior) = OPTIONAL]; } // Schema information describing the structure and layout of the data. @@ -595,8 +583,8 @@ message Schema { // and must begin with a letter or underscore. string name = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. User friendly field description. Must be less than or equal to 1024 - // characters. + // Optional. User friendly field description. Must be less than or equal to + // 1024 characters. string description = 2 [(google.api.field_behavior) = OPTIONAL]; // Required. The type of field. @@ -614,9 +602,9 @@ message Schema { // filtering ability due to performance consideration. **Note:** // Partition fields are immutable. message PartitionField { - // Required. Partition field name must consist of letters, numbers, and underscores - // only, with a maximum of length of 256 characters, - // and must begin with a letter or underscore.. + // Required. Partition field name must consist of letters, numbers, and + // underscores only, with a maximum of length of 256 characters, and must + // begin with a letter or underscore.. string name = 1 [(google.api.field_behavior) = REQUIRED]; // Required. Immutable. The type of field. @@ -637,8 +625,8 @@ message Schema { HIVE_COMPATIBLE = 1; } - // Required. Set to `true` if user-managed or `false` if managed by Dataplex. The - // default is `false` (managed by Dataplex). + // Required. Set to `true` if user-managed or `false` if managed by Dataplex. + // The default is `false` (managed by Dataplex). // // - Set to `false`to enable Dataplex discovery to update the schema. // including new data discovery, schema inference, and schema evolution. @@ -656,11 +644,13 @@ message Schema { // **Note:** BigQuery SchemaFields are immutable. repeated SchemaField fields = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The sequence of fields describing the partition structure in entities. - // If this field is empty, there are no partitions within the data. - repeated PartitionField partition_fields = 3 [(google.api.field_behavior) = OPTIONAL]; + // Optional. The sequence of fields describing the partition structure in + // entities. If this field is empty, there are no partitions within the data. + repeated PartitionField partition_fields = 3 + [(google.api.field_behavior) = OPTIONAL]; - // Optional. The structure of paths containing partition data within the entity. + // Optional. The structure of paths containing partition data within the + // entity. PartitionStyle partition_style = 4 [(google.api.field_behavior) = OPTIONAL]; } @@ -668,12 +658,12 @@ message Schema { message StorageFormat { // Describes CSV and similar semi-structured data formats. message CsvOptions { - // Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8", and - // "ISO-8859-1". Defaults to UTF-8 if unspecified. + // Optional. The character encoding of the data. Accepts "US-ASCII", + // "UTF-8", and "ISO-8859-1". Defaults to UTF-8 if unspecified. string encoding = 1 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The number of rows to interpret as header rows that should be skipped - // when reading data rows. Defaults to 0. + // Optional. The number of rows to interpret as header rows that should be + // skipped when reading data rows. Defaults to 0. int32 header_rows = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. The delimiter used to separate values. Defaults to ','. @@ -687,8 +677,8 @@ message StorageFormat { // Describes JSON data format. message JsonOptions { - // Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8" and - // "ISO-8859-1". Defaults to UTF-8 if not specified. + // Optional. The character encoding of the data. Accepts "US-ASCII", "UTF-8" + // and "ISO-8859-1". Defaults to UTF-8 if not specified. string encoding = 1 [(google.api.field_behavior) = OPTIONAL]; } @@ -746,13 +736,14 @@ message StorageFormat { BZIP2 = 3; } - // Output only. The data format associated with the stored data, which represents - // content type values. The value is inferred from mime type. + // Output only. The data format associated with the stored data, which + // represents content type values. The value is inferred from mime type. Format format = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. The compression type associated with the stored data. // If unspecified, the data is uncompressed. - CompressionFormat compression_format = 2 [(google.api.field_behavior) = OPTIONAL]; + CompressionFormat compression_format = 2 + [(google.api.field_behavior) = OPTIONAL]; // Required. The mime type descriptor for the data. Must match the pattern // {type}/{subtype}. Supported values: diff --git a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/resources.proto b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/resources.proto index e07caac233a..22dc8fc208d 100644 --- a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/resources.proto +++ b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/resources.proto @@ -86,23 +86,23 @@ message Lake { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string name = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; // Optional. User friendly display name. string display_name = 2 [(google.api.field_behavior) = OPTIONAL]; - // Output only. System generated globally unique ID for the lake. This ID will be - // different if the lake is deleted and re-created with the same name. + // Output only. System generated globally unique ID for the lake. This ID will + // be different if the lake is deleted and re-created with the same name. string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the lake was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the lake was last updated. - google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. User-defined labels for the lake. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; @@ -113,8 +113,9 @@ message Lake { // Output only. Current state of the lake. State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Service account associated with this lake. This service account must be - // authorized to access or operate on resources managed by the lake. + // Output only. Service account associated with this lake. This service + // account must be authorized to access or operate on resources managed by the + // lake. string service_account = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. Settings to manage lake and Dataproc Metastore service instance @@ -125,7 +126,8 @@ message Lake { AssetStatus asset_status = 103 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Metastore status of the lake. - MetastoreStatus metastore_status = 104 [(google.api.field_behavior) = OUTPUT_ONLY]; + MetastoreStatus metastore_status = 104 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // Aggregated status of the underlying assets of a lake or zone. @@ -181,8 +183,8 @@ message Zone { MULTI_REGION = 2; } - // Required. Immutable. The location type of the resources that are allowed to be attached to the - // assets within this zone. + // Required. Immutable. The location type of the resources that are allowed + // to be attached to the assets within this zone. LocationType location_type = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.field_behavior) = IMMUTABLE @@ -193,11 +195,12 @@ message Zone { message DiscoverySpec { // Describe CSV and similar semi-structured data formats. message CsvOptions { - // Optional. The number of rows to interpret as header rows that should be skipped - // when reading data rows. + // Optional. The number of rows to interpret as header rows that should be + // skipped when reading data rows. int32 header_rows = 1 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The delimiter being used to separate values. This defaults to ','. + // Optional. The delimiter being used to separate values. This defaults to + // ','. string delimiter = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. The character encoding of the data. The default is UTF-8. @@ -222,18 +225,20 @@ message Zone { // Required. Whether discovery is enabled. bool enabled = 1 [(google.api.field_behavior) = REQUIRED]; - // Optional. The list of patterns to apply for selecting data to include during - // discovery if only a subset of the data should considered. For Cloud - // Storage bucket assets, these are interpreted as glob patterns used to - // match object names. For BigQuery dataset assets, these are - // interpreted as patterns to match table names. - repeated string include_patterns = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The list of patterns to apply for selecting data to exclude during - // discovery. For Cloud Storage bucket assets, these are interpreted as - // glob patterns used to match object names. For BigQuery dataset assets, + // Optional. The list of patterns to apply for selecting data to include + // during discovery if only a subset of the data should considered. For + // Cloud Storage bucket assets, these are interpreted as glob patterns used + // to match object names. For BigQuery dataset assets, these are interpreted + // as patterns to match table names. + repeated string include_patterns = 2 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The list of patterns to apply for selecting data to exclude + // during discovery. For Cloud Storage bucket assets, these are interpreted + // as glob patterns used to match object names. For BigQuery dataset assets, // these are interpreted as patterns to match table names. - repeated string exclude_patterns = 3 [(google.api.field_behavior) = OPTIONAL]; + repeated string exclude_patterns = 3 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Configuration for CSV data. CsvOptions csv_options = 4 [(google.api.field_behavior) = OPTIONAL]; @@ -243,15 +248,14 @@ message Zone { // Determines when discovery is triggered. oneof trigger { - // Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running - // discovery periodically. Successive discovery runs must be scheduled at - // least 60 minutes apart. - // The default value is to run discovery every 60 minutes. - // To explicitly set a timezone to the cron tab, apply a prefix in the - // cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or TZ=${IANA_TIME_ZONE}". - // The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone - // database. For example, "CRON_TZ=America/New_York 1 * * * *", or - // "TZ=America/New_York 1 * * * *". + // Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for + // running discovery periodically. Successive discovery runs must be + // scheduled at least 60 minutes apart. The default value is to run + // discovery every 60 minutes. To explicitly set a timezone to the cron + // tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or + // TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string + // from IANA time zone database. For example, "CRON_TZ=America/New_York 1 + // * * * *", or "TZ=America/New_York 1 * * * *". string schedule = 10 [(google.api.field_behavior) = OPTIONAL]; } } @@ -260,23 +264,23 @@ message Zone { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string name = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; // Optional. User friendly display name. string display_name = 2 [(google.api.field_behavior) = OPTIONAL]; - // Output only. System generated globally unique ID for the zone. This ID will be - // different if the zone is deleted and re-created with the same name. + // Output only. System generated globally unique ID for the zone. This ID will + // be different if the zone is deleted and re-created with the same name. string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the zone was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the zone was last updated. - google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. User defined labels for the zone. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; @@ -293,11 +297,12 @@ message Zone { (google.api.field_behavior) = IMMUTABLE ]; - // Optional. Specification of the discovery feature applied to data in this zone. + // Optional. Specification of the discovery feature applied to data in this + // zone. DiscoverySpec discovery_spec = 103 [(google.api.field_behavior) = OPTIONAL]; - // Required. Specification of the resources that are referenced by the assets within - // this zone. + // Required. Specification of the resources that are referenced by the assets + // within this zone. ResourceSpec resource_spec = 104 [(google.api.field_behavior) = REQUIRED]; // Output only. Aggregated status of the underlying assets of the zone. @@ -329,16 +334,12 @@ message Action { } // Action details for resource references in assets that cannot be located. - message MissingResource { - - } + message MissingResource {} // Action details for unauthorized resource issues raised to indicate that the // service account associated with the lake instance is not authorized to // access or manage the resource associated with an asset. - message UnauthorizedResource { - - } + message UnauthorizedResource {} // Failed to apply security policy to the managed resource(s) under a // lake, zone or an asset. For a lake or zone resource, one or more underlying @@ -416,14 +417,10 @@ message Action { } // Action details for absence of data detected by discovery. - message MissingData { - - } + message MissingData {} // Action details for invalid data arrangement. - message InvalidDataOrganization { - - } + message InvalidDataOrganization {} // The category of issue associated with the action. Category category = 1; @@ -440,36 +437,28 @@ message Action { // `projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}/actions/{action}`. string name = 5 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Action" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Action" } ]; // Output only. The relative resource name of the lake, of the form: // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string lake = 6 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; // Output only. The relative resource name of the zone, of the form: // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string zone = 7 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; // Output only. The relative resource name of the asset, of the form: // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. string asset = 8 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Asset" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Asset" } ]; // The list of data locations associated with this action. Cloud Storage @@ -552,11 +541,12 @@ message Asset { message DiscoverySpec { // Describe CSV and similar semi-structured data formats. message CsvOptions { - // Optional. The number of rows to interpret as header rows that should be skipped - // when reading data rows. + // Optional. The number of rows to interpret as header rows that should be + // skipped when reading data rows. int32 header_rows = 1 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The delimiter being used to separate values. This defaults to ','. + // Optional. The delimiter being used to separate values. This defaults to + // ','. string delimiter = 2 [(google.api.field_behavior) = OPTIONAL]; // Optional. The character encoding of the data. The default is UTF-8. @@ -581,18 +571,20 @@ message Asset { // Optional. Whether discovery is enabled. bool enabled = 1 [(google.api.field_behavior) = OPTIONAL]; - // Optional. The list of patterns to apply for selecting data to include during - // discovery if only a subset of the data should considered. For Cloud - // Storage bucket assets, these are interpreted as glob patterns used to - // match object names. For BigQuery dataset assets, these are interpreted as - // patterns to match table names. - repeated string include_patterns = 2 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. The list of patterns to apply for selecting data to exclude during - // discovery. For Cloud Storage bucket assets, these are interpreted as - // glob patterns used to match object names. For BigQuery dataset assets, + // Optional. The list of patterns to apply for selecting data to include + // during discovery if only a subset of the data should considered. For + // Cloud Storage bucket assets, these are interpreted as glob patterns used + // to match object names. For BigQuery dataset assets, these are interpreted + // as patterns to match table names. + repeated string include_patterns = 2 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The list of patterns to apply for selecting data to exclude + // during discovery. For Cloud Storage bucket assets, these are interpreted + // as glob patterns used to match object names. For BigQuery dataset assets, // these are interpreted as patterns to match table names. - repeated string exclude_patterns = 3 [(google.api.field_behavior) = OPTIONAL]; + repeated string exclude_patterns = 3 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Configuration for CSV data. CsvOptions csv_options = 4 [(google.api.field_behavior) = OPTIONAL]; @@ -602,15 +594,14 @@ message Asset { // Determines when discovery is triggered. oneof trigger { - // Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running - // discovery periodically. Successive discovery runs must be scheduled at - // least 60 minutes apart. - // The default value is to run discovery every 60 minutes. - // To explicitly set a timezone to the cron tab, apply a prefix in the - // cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or TZ=${IANA_TIME_ZONE}". - // The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone - // database. For example, "CRON_TZ=America/New_York 1 * * * *", or - // "TZ=America/New_York 1 * * * *". + // Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for + // running discovery periodically. Successive discovery runs must be + // scheduled at least 60 minutes apart. The default value is to run + // discovery every 60 minutes. To explicitly set a timezone to the cron + // tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or + // TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string + // from IANA time zone database. For example, "CRON_TZ=America/New_York 1 + // * * * *", or "TZ=America/New_York 1 * * * *". string schedule = 10 [(google.api.field_behavior) = OPTIONAL]; } } @@ -629,8 +620,8 @@ message Asset { BIGQUERY_DATASET = 2; } - // Immutable. Relative name of the cloud resource that contains the data that is - // being managed within a lake. For example: + // Immutable. Relative name of the cloud resource that contains the data + // that is being managed within a lake. For example: // `projects/{project_number}/buckets/{bucket_id}` // `projects/{project_number}/datasets/{dataset_id}` string name = 1 [(google.api.field_behavior) = IMMUTABLE]; @@ -725,23 +716,24 @@ message Asset { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. string name = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Asset" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Asset" } ]; // Optional. User friendly display name. string display_name = 2 [(google.api.field_behavior) = OPTIONAL]; - // Output only. System generated globally unique ID for the asset. This ID will be - // different if the asset is deleted and re-created with the same name. + // Output only. System generated globally unique ID for the asset. This ID + // will be different if the asset is deleted and re-created with the same + // name. string uid = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the asset was created. - google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the asset was last updated. - google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 5 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. User defined labels for the asset. map labels = 6 [(google.api.field_behavior) = OPTIONAL]; @@ -756,19 +748,23 @@ message Asset { ResourceSpec resource_spec = 100 [(google.api.field_behavior) = REQUIRED]; // Output only. Status of the resource referenced by this asset. - ResourceStatus resource_status = 101 [(google.api.field_behavior) = OUTPUT_ONLY]; + ResourceStatus resource_status = 101 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. Status of the security policy applied to resource referenced by this asset. - SecurityStatus security_status = 103 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Status of the security policy applied to resource referenced + // by this asset. + SecurityStatus security_status = 103 + [(google.api.field_behavior) = OUTPUT_ONLY]; - // Optional. Specification of the discovery feature applied to data referenced by this - // asset. - // When this spec is left unset, the asset will use the spec set on the parent - // zone. + // Optional. Specification of the discovery feature applied to data referenced + // by this asset. When this spec is left unset, the asset will use the spec + // set on the parent zone. DiscoverySpec discovery_spec = 106 [(google.api.field_behavior) = OPTIONAL]; - // Output only. Status of the discovery feature applied to data referenced by this asset. - DiscoveryStatus discovery_status = 107 [(google.api.field_behavior) = OUTPUT_ONLY]; + // Output only. Status of the discovery feature applied to data referenced by + // this asset. + DiscoveryStatus discovery_status = 107 + [(google.api.field_behavior) = OUTPUT_ONLY]; } // State of a resource. diff --git a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/service.proto b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/service.proto index f7995c07b75..d23ca8e2f86 100644 --- a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/service.proto +++ b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/service.proto @@ -40,7 +40,8 @@ option java_package = "com.google.cloud.dataplex.v1"; // systems including Cloud Storage and BigQuery. service DataplexService { option (google.api.default_host) = "dataplex.googleapis.com"; - option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform"; // Creates a lake resource. rpc CreateLake(CreateLakeRequest) returns (google.longrunning.Operation) { @@ -311,7 +312,8 @@ service DataplexService { } // Create an environment resource. - rpc CreateEnvironment(CreateEnvironmentRequest) returns (google.longrunning.Operation) { + rpc CreateEnvironment(CreateEnvironmentRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*/lakes/*}/environments" body: "environment" @@ -324,7 +326,8 @@ service DataplexService { } // Update the environment resource. - rpc UpdateEnvironment(UpdateEnvironmentRequest) returns (google.longrunning.Operation) { + rpc UpdateEnvironment(UpdateEnvironmentRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/{environment.name=projects/*/locations/*/lakes/*/environments/*}" body: "environment" @@ -338,7 +341,8 @@ service DataplexService { // Delete the environment resource. All the child resources must have been // deleted before environment deletion can be initiated. - rpc DeleteEnvironment(DeleteEnvironmentRequest) returns (google.longrunning.Operation) { + rpc DeleteEnvironment(DeleteEnvironmentRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/lakes/*/environments/*}" }; @@ -350,7 +354,8 @@ service DataplexService { } // Lists environments under the given lake. - rpc ListEnvironments(ListEnvironmentsRequest) returns (ListEnvironmentsResponse) { + rpc ListEnvironments(ListEnvironmentsRequest) + returns (ListEnvironmentsResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*/lakes/*}/environments" }; @@ -407,7 +412,8 @@ message CreateLakeRequest { // Update lake request. message UpdateLakeRequest { // Required. Mask of fields to update. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Update description. // Only fields specified in `update_mask` are updated. @@ -424,9 +430,7 @@ message DeleteLakeRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; } @@ -442,13 +446,13 @@ message ListLakesRequest { } ]; - // Optional. Maximum number of Lakes to return. The service may return fewer than this - // value. If unspecified, at most 10 lakes will be returned. The maximum - // value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of Lakes to return. The service may return fewer + // than this value. If unspecified, at most 10 lakes will be returned. The + // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListLakes` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters + // Optional. Page token received from a previous `ListLakes` call. Provide + // this to retrieve the subsequent page. When paginating, all other parameters // provided to `ListLakes` must match the call that provided the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; @@ -478,20 +482,18 @@ message ListLakeActionsRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; - // Optional. Maximum number of actions to return. The service may return fewer than this - // value. If unspecified, at most 10 actions will be returned. The maximum - // value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of actions to return. The service may return fewer + // than this value. If unspecified, at most 10 actions will be returned. The + // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListLakeActions` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters - // provided to `ListLakeActions` must match the call that provided the page - // token. + // Optional. Page token received from a previous `ListLakeActions` call. + // Provide this to retrieve the subsequent page. When paginating, all other + // parameters provided to `ListLakeActions` must match the call that provided + // the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; } @@ -511,9 +513,7 @@ message GetLakeRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; } @@ -523,9 +523,7 @@ message CreateZoneRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; // Required. Zone identifier. @@ -550,7 +548,8 @@ message CreateZoneRequest { // Update zone request. message UpdateZoneRequest { // Required. Mask of fields to update. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Update description. // Only fields specified in `update_mask` are updated. @@ -567,9 +566,7 @@ message DeleteZoneRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; } @@ -579,18 +576,16 @@ message ListZonesRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; - // Optional. Maximum number of zones to return. The service may return fewer than this - // value. If unspecified, at most 10 zones will be returned. The maximum - // value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of zones to return. The service may return fewer + // than this value. If unspecified, at most 10 zones will be returned. The + // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListZones` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters + // Optional. Page token received from a previous `ListZones` call. Provide + // this to retrieve the subsequent page. When paginating, all other parameters // provided to `ListZones` must match the call that provided the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; @@ -617,20 +612,18 @@ message ListZoneActionsRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; - // Optional. Maximum number of actions to return. The service may return fewer than this - // value. If unspecified, at most 10 actions will be returned. The maximum - // value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of actions to return. The service may return fewer + // than this value. If unspecified, at most 10 actions will be returned. The + // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListZoneActions` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters - // provided to `ListZoneActions` must match the call that provided the page - // token. + // Optional. Page token received from a previous `ListZoneActions` call. + // Provide this to retrieve the subsequent page. When paginating, all other + // parameters provided to `ListZoneActions` must match the call that provided + // the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; } @@ -640,9 +633,7 @@ message GetZoneRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; } @@ -652,9 +643,7 @@ message CreateAssetRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; // Required. Asset identifier. @@ -678,7 +667,8 @@ message CreateAssetRequest { // Update asset request. message UpdateAssetRequest { // Required. Mask of fields to update. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Update description. // Only fields specified in `update_mask` are updated. @@ -695,9 +685,7 @@ message DeleteAssetRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Asset" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Asset" } ]; } @@ -707,18 +695,16 @@ message ListAssetsRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Zone" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Zone" } ]; - // Optional. Maximum number of asset to return. The service may return fewer than - // this value. If unspecified, at most 10 assets will be returned. The + // Optional. Maximum number of asset to return. The service may return fewer + // than this value. If unspecified, at most 10 assets will be returned. The // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListAssets` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters + // Optional. Page token received from a previous `ListAssets` call. Provide + // this to retrieve the subsequent page. When paginating, all other parameters // provided to `ListAssets` must match the call that provided the page // token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; @@ -746,20 +732,18 @@ message ListAssetActionsRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Asset" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Asset" } ]; - // Optional. Maximum number of actions to return. The service may return fewer than this - // value. If unspecified, at most 10 actions will be returned. The maximum - // value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of actions to return. The service may return fewer + // than this value. If unspecified, at most 10 actions will be returned. The + // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListAssetActions` call. Provide this - // to retrieve the subsequent page. When paginating, all other parameters - // provided to `ListAssetActions` must match the call that provided the page - // token. + // Optional. Page token received from a previous `ListAssetActions` call. + // Provide this to retrieve the subsequent page. When paginating, all other + // parameters provided to `ListAssetActions` must match the call that provided + // the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; } @@ -769,19 +753,19 @@ message GetAssetRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Asset" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Asset" } ]; } // Represents the metadata of a long-running operation. message OperationMetadata { // Output only. The time the operation was created. - google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 1 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time the operation finished running. - google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 2 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Server-defined resource path for the target of the operation. string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -794,8 +778,9 @@ message OperationMetadata { // Output only. Identifies whether the user has requested cancellation // of the operation. Operations that have successfully been cancelled - // have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, - // corresponding to `Code.CANCELLED`. + // have [Operation.error][] value with a + // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to + // `Code.CANCELLED`. bool requested_cancellation = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. API version used to start the operation. @@ -808,9 +793,7 @@ message CreateTaskRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; // Required. Task identifier. @@ -827,7 +810,8 @@ message CreateTaskRequest { // Update task request. message UpdateTaskRequest { // Required. Mask of fields to update. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Update description. // Only fields specified in `update_mask` are updated. @@ -844,9 +828,7 @@ message DeleteTaskRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Task" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Task" } ]; } @@ -856,18 +838,16 @@ message ListTasksRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; - // Optional. Maximum number of tasks to return. The service may return fewer than this - // value. If unspecified, at most 10 tasks will be returned. The maximum - // value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of tasks to return. The service may return fewer + // than this value. If unspecified, at most 10 tasks will be returned. The + // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListZones` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters + // Optional. Page token received from a previous `ListZones` call. Provide + // this to retrieve the subsequent page. When paginating, all other parameters // provided to `ListZones` must match the call that provided the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; @@ -897,9 +877,7 @@ message GetTaskRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Task" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Task" } ]; } @@ -909,9 +887,7 @@ message GetJobRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Job" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Job" } ]; } @@ -921,18 +897,16 @@ message ListJobsRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Task" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Task" } ]; - // Optional. Maximum number of jobs to return. The service may return fewer than - // this value. If unspecified, at most 10 jobs will be returned. The + // Optional. Maximum number of jobs to return. The service may return fewer + // than this value. If unspecified, at most 10 jobs will be returned. The // maximum value is 1000; values above 1000 will be coerced to 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListJobs` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters + // Optional. Page token received from a previous `ListJobs` call. Provide this + // to retrieve the subsequent page. When paginating, all other parameters // provided to `ListJobs` must match the call that provided the page // token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; @@ -954,9 +928,7 @@ message CancelJobRequest { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}/job/{job_id}`. string name = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Job" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Job" } ]; } @@ -966,9 +938,7 @@ message CreateEnvironmentRequest { // `projects/{project_id}/locations/{location_id}/lakes/{lake_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; // Required. Environment identifier. @@ -990,7 +960,8 @@ message CreateEnvironmentRequest { // Update environment request. message UpdateEnvironmentRequest { // Required. Mask of fields to update. - google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = REQUIRED]; + google.protobuf.FieldMask update_mask = 1 + [(google.api.field_behavior) = REQUIRED]; // Required. Update description. // Only fields specified in `update_mask` are updated. @@ -1019,20 +990,19 @@ message ListEnvironmentsRequest { // `projects/{project_id}/locations/{location_id}/lakes/{lake_id}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Lake" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Lake" } ]; - // Optional. Maximum number of environments to return. The service may return fewer than - // this value. If unspecified, at most 10 environments will be returned. The - // maximum value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of environments to return. The service may return + // fewer than this value. If unspecified, at most 10 environments will be + // returned. The maximum value is 1000; values above 1000 will be coerced to + // 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListEnvironments` call. Provide this - // to retrieve the subsequent page. When paginating, all other parameters - // provided to `ListEnvironments` must match the call that provided the page - // token. + // Optional. Page token received from a previous `ListEnvironments` call. + // Provide this to retrieve the subsequent page. When paginating, all other + // parameters provided to `ListEnvironments` must match the call that provided + // the page token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; // Optional. Filter request. @@ -1075,24 +1045,24 @@ message ListSessionsRequest { } ]; - // Optional. Maximum number of sessions to return. The service may return fewer than - // this value. If unspecified, at most 10 sessions will be returned. The - // maximum value is 1000; values above 1000 will be coerced to 1000. + // Optional. Maximum number of sessions to return. The service may return + // fewer than this value. If unspecified, at most 10 sessions will be + // returned. The maximum value is 1000; values above 1000 will be coerced to + // 1000. int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Page token received from a previous `ListSessions` call. Provide this to - // retrieve the subsequent page. When paginating, all other parameters + // Optional. Page token received from a previous `ListSessions` call. Provide + // this to retrieve the subsequent page. When paginating, all other parameters // provided to `ListSessions` must match the call that provided the page // token. string page_token = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Filter request. The following `mode` filter is supported to return only the - // sessions belonging to the requester when the mode is USER and return - // sessions of all the users when the mode is ADMIN. When no filter is sent - // default to USER mode. - // NOTE: When the mode is ADMIN, the requester should have - // `dataplex.environments.listAllSessions` permission to list all sessions, - // in absence of the permission, the request fails. + // Optional. Filter request. The following `mode` filter is supported to + // return only the sessions belonging to the requester when the mode is USER + // and return sessions of all the users when the mode is ADMIN. When no filter + // is sent default to USER mode. NOTE: When the mode is ADMIN, the requester + // should have `dataplex.environments.listAllSessions` permission to list all + // sessions, in absence of the permission, the request fails. // // mode = ADMIN | USER string filter = 4 [(google.api.field_behavior) = OPTIONAL]; diff --git a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/tasks.proto b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/tasks.proto index 214be25582e..5ca403bdbf4 100644 --- a/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/tasks.proto +++ b/packages/google-cloud-dataplex/protos/google/cloud/dataplex/v1/tasks.proto @@ -61,24 +61,24 @@ message Task { // Optional. A list of python packages to be installed. // Valid formats include Cloud Storage URI to a PIP installable library. // For example, gs://bucket-name/my/path/to/lib.tar.gz - repeated string python_packages = 3 [(google.api.field_behavior) = OPTIONAL]; - - // Optional. Override to common configuration of open source components installed on - // the Dataproc cluster. - // The properties to set on daemon config files. - // Property keys are specified in `prefix:property` format, for example - // `core:hadoop.tmp.dir`. - // For more information, see [Cluster + repeated string python_packages = 3 + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. Override to common configuration of open source components + // installed on the Dataproc cluster. The properties to set on daemon + // config files. Property keys are specified in `prefix:property` format, + // for example `core:hadoop.tmp.dir`. For more information, see [Cluster // properties](https://cloud.google.com/dataproc/docs/concepts/cluster-properties). - map properties = 4 [(google.api.field_behavior) = OPTIONAL]; + map properties = 4 + [(google.api.field_behavior) = OPTIONAL]; } // Cloud VPC Network used to run the infrastructure. message VpcNetwork { // The Cloud VPC network identifier. oneof network_name { - // Optional. The Cloud VPC network in which the job is run. By default, the Cloud - // VPC network named Default within the project is used. + // Optional. The Cloud VPC network in which the job is run. By default, + // the Cloud VPC network named Default within the project is used. string network = 1 [(google.api.field_behavior) = OPTIONAL]; // Optional. The Cloud VPC sub-network in which the job is run. @@ -131,7 +131,8 @@ message Task { // Optional. The first run of the task will be after this time. // If not specified, the task will run shortly after being submitted if // ON_DEMAND and based on the schedule if RECURRING. - google.protobuf.Timestamp start_time = 6 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.Timestamp start_time = 6 + [(google.api.field_behavior) = OPTIONAL]; // Optional. Prevent the task from executing. // This does not cancel already running tasks. It is intended to temporarily @@ -144,14 +145,13 @@ message Task { // Trigger only applies for RECURRING tasks. oneof trigger { - // Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running - // tasks periodically. - // To explicitly set a timezone to the cron tab, apply a prefix in the - // cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". - // The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone - // database. For example, "CRON_TZ=America/New_York 1 * * * *", or - // "TZ=America/New_York 1 * * * *". - // This field is required for RECURRING tasks. + // Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for + // running tasks periodically. To explicitly set a timezone to the cron + // tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or + // "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid + // string from IANA time zone database. For example, + // "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * + // *". This field is required for RECURRING tasks. string schedule = 100 [(google.api.field_behavior) = OPTIONAL]; } } @@ -177,13 +177,15 @@ message Task { // used. string service_account = 5 [(google.api.field_behavior) = REQUIRED]; - // Optional. The project in which jobs are run. By default, the project containing the - // Lake is used. If a project is provided, the - // [ExecutionSpec.service_account][google.cloud.dataplex.v1.Task.ExecutionSpec.service_account] must belong to this project. + // Optional. The project in which jobs are run. By default, the project + // containing the Lake is used. If a project is provided, the + // [ExecutionSpec.service_account][google.cloud.dataplex.v1.Task.ExecutionSpec.service_account] + // must belong to this project. string project = 7 [(google.api.field_behavior) = OPTIONAL]; // Optional. The maximum duration after which the job execution is expired. - google.protobuf.Duration max_job_execution_lifetime = 8 [(google.api.field_behavior) = OPTIONAL]; + google.protobuf.Duration max_job_execution_lifetime = 8 + [(google.api.field_behavior) = OPTIONAL]; // Optional. The Cloud KMS key to use for encryption, of the form: // `projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}`. @@ -225,44 +227,47 @@ message Task { string sql_script = 105; } - // Optional. Cloud Storage URIs of files to be placed in the working directory of each - // executor. + // Optional. Cloud Storage URIs of files to be placed in the working + // directory of each executor. repeated string file_uris = 3 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Cloud Storage URIs of archives to be extracted into the working directory - // of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and - // .zip. + // Optional. Cloud Storage URIs of archives to be extracted into the working + // directory of each executor. Supported file types: .jar, .tar, .tar.gz, + // .tgz, and .zip. repeated string archive_uris = 4 [(google.api.field_behavior) = OPTIONAL]; // Optional. Infrastructure specification for the execution. - InfrastructureSpec infrastructure_spec = 6 [(google.api.field_behavior) = OPTIONAL]; + InfrastructureSpec infrastructure_spec = 6 + [(google.api.field_behavior) = OPTIONAL]; } // Config for running scheduled notebooks. message NotebookTaskConfig { - // Required. Path to input notebook. This can be the Cloud Storage URI of the notebook - // file or the path to a Notebook Content. The execution args are accessible - // as environment variables + // Required. Path to input notebook. This can be the Cloud Storage URI of + // the notebook file or the path to a Notebook Content. The execution args + // are accessible as environment variables // (`TASK_key=value`). string notebook = 4 [(google.api.field_behavior) = REQUIRED]; // Optional. Infrastructure specification for the execution. - InfrastructureSpec infrastructure_spec = 3 [(google.api.field_behavior) = OPTIONAL]; + InfrastructureSpec infrastructure_spec = 3 + [(google.api.field_behavior) = OPTIONAL]; - // Optional. Cloud Storage URIs of files to be placed in the working directory of each - // executor. + // Optional. Cloud Storage URIs of files to be placed in the working + // directory of each executor. repeated string file_uris = 5 [(google.api.field_behavior) = OPTIONAL]; - // Optional. Cloud Storage URIs of archives to be extracted into the working directory - // of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and - // .zip. + // Optional. Cloud Storage URIs of archives to be extracted into the working + // directory of each executor. Supported file types: .jar, .tar, .tar.gz, + // .tgz, and .zip. repeated string archive_uris = 6 [(google.api.field_behavior) = OPTIONAL]; } // Status of the task execution (e.g. Jobs). message ExecutionStatus { // Output only. Last update time of the status. - google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. latest job execution Job latest_job = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -273,20 +278,20 @@ message Task { // tasks/{task_id}. string name = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Task" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Task" } ]; - // Output only. System generated globally unique ID for the task. This ID will be - // different if the task is deleted and re-created with the same name. + // Output only. System generated globally unique ID for the task. This ID will + // be different if the task is deleted and re-created with the same name. string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the task was created. - google.protobuf.Timestamp create_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp create_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the task was last updated. - google.protobuf.Timestamp update_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp update_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Optional. Description of the task. string description = 5 [(google.api.field_behavior) = OPTIONAL]; @@ -307,7 +312,8 @@ message Task { ExecutionSpec execution_spec = 101 [(google.api.field_behavior) = REQUIRED]; // Output only. Status of the latest task executions. - ExecutionStatus execution_status = 201 [(google.api.field_behavior) = OUTPUT_ONLY]; + ExecutionStatus execution_status = 201 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Task template specific user-specified config. oneof config { @@ -361,19 +367,19 @@ message Job { // `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}`. string name = 1 [ (google.api.field_behavior) = OUTPUT_ONLY, - (google.api.resource_reference) = { - type: "dataplex.googleapis.com/Job" - } + (google.api.resource_reference) = { type: "dataplex.googleapis.com/Job" } ]; // Output only. System generated globally unique ID for the job. string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the job was started. - google.protobuf.Timestamp start_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp start_time = 3 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. The time when the job ended. - google.protobuf.Timestamp end_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; + google.protobuf.Timestamp end_time = 4 + [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Execution state for the job. State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; @@ -385,7 +391,8 @@ message Job { // Output only. The underlying service running a job. Service service = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; - // Output only. The full resource name for the job run under a particular service. + // Output only. The full resource name for the job run under a particular + // service. string service_job = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; // Output only. Additional information about the current state. diff --git a/packages/google-cloud-dataplex/samples/generated/v1/content_service.list_content.js b/packages/google-cloud-dataplex/samples/generated/v1/content_service.list_content.js index cb0300dbe05..5ed1deb6fd5 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/content_service.list_content.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/content_service.list_content.js @@ -34,14 +34,14 @@ function main(parent) { */ // const parent = 'abc123' /** - * Optional. Maximum number of content to return. The service may return fewer than - * this value. If unspecified, at most 10 content will be returned. The + * Optional. Maximum number of content to return. The service may return fewer + * than this value. If unspecified, at most 10 content will be returned. The * maximum value is 1000; values above 1000 will be coerced to 1000. */ // const pageSize = 1234 /** - * Optional. Page token received from a previous `ListContent` call. Provide this - * to retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListContent` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListContent` must match the call that provided the page * token. */ diff --git a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_asset_actions.js b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_asset_actions.js index 976c3c9b68d..a57f5675f94 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_asset_actions.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_asset_actions.js @@ -34,16 +34,16 @@ function main(parent) { */ // const parent = 'abc123' /** - * Optional. Maximum number of actions to return. The service may return fewer than this - * value. If unspecified, at most 10 actions will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of actions to return. The service may return fewer + * than this value. If unspecified, at most 10 actions will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. */ // const pageSize = 1234 /** - * Optional. Page token received from a previous `ListAssetActions` call. Provide this - * to retrieve the subsequent page. When paginating, all other parameters - * provided to `ListAssetActions` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListAssetActions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListAssetActions` must match the call that provided + * the page token. */ // const pageToken = 'abc123' diff --git a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_assets.js b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_assets.js index fdccf0f0221..a12e9d70c5f 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_assets.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_assets.js @@ -34,14 +34,14 @@ function main(parent) { */ // const parent = 'abc123' /** - * Optional. Maximum number of asset to return. The service may return fewer than - * this value. If unspecified, at most 10 assets will be returned. The + * Optional. Maximum number of asset to return. The service may return fewer + * than this value. If unspecified, at most 10 assets will be returned. The * maximum value is 1000; values above 1000 will be coerced to 1000. */ // const pageSize = 1234 /** - * Optional. Page token received from a previous `ListAssets` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListAssets` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListAssets` must match the call that provided the page * token. */ diff --git a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_environments.js b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_environments.js index 3535419f93c..0334e6ea02e 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_environments.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_environments.js @@ -34,16 +34,17 @@ function main(parent) { */ // const parent = 'abc123' /** - * Optional. Maximum number of environments to return. The service may return fewer than - * this value. If unspecified, at most 10 environments will be returned. The - * maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of environments to return. The service may return + * fewer than this value. If unspecified, at most 10 environments will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. */ // const pageSize = 1234 /** - * Optional. Page token received from a previous `ListEnvironments` call. Provide this - * to retrieve the subsequent page. When paginating, all other parameters - * provided to `ListEnvironments` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListEnvironments` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListEnvironments` must match the call that provided + * the page token. */ // const pageToken = 'abc123' /** diff --git a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_jobs.js b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_jobs.js index e5ecf3a696f..d447ac6cd5b 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_jobs.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_jobs.js @@ -34,14 +34,14 @@ function main(parent) { */ // const parent = 'abc123' /** - * Optional. Maximum number of jobs to return. The service may return fewer than - * this value. If unspecified, at most 10 jobs will be returned. The + * Optional. Maximum number of jobs to return. The service may return fewer + * than this value. If unspecified, at most 10 jobs will be returned. The * maximum value is 1000; values above 1000 will be coerced to 1000. */ // const pageSize = 1234 /** - * Optional. Page token received from a previous `ListJobs` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListJobs` call. Provide this + * to retrieve the subsequent page. When paginating, all other parameters * provided to `ListJobs` must match the call that provided the page * token. */ diff --git a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_lake_actions.js b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_lake_actions.js index 7a086e30410..0491f1a491c 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_lake_actions.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_lake_actions.js @@ -34,16 +34,16 @@ function main(parent) { */ // const parent = 'abc123' /** - * Optional. Maximum number of actions to return. The service may return fewer than this - * value. If unspecified, at most 10 actions will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of actions to return. The service may return fewer + * than this value. If unspecified, at most 10 actions will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. */ // const pageSize = 1234 /** - * Optional. Page token received from a previous `ListLakeActions` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters - * provided to `ListLakeActions` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListLakeActions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListLakeActions` must match the call that provided + * the page token. */ // const pageToken = 'abc123' diff --git a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_lakes.js b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_lakes.js index bb74f9a9d85..895d05b4a9a 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_lakes.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_lakes.js @@ -35,14 +35,14 @@ function main(parent) { */ // const parent = 'abc123' /** - * Optional. Maximum number of Lakes to return. The service may return fewer than this - * value. If unspecified, at most 10 lakes will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of Lakes to return. The service may return fewer + * than this value. If unspecified, at most 10 lakes will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. */ // const pageSize = 1234 /** - * Optional. Page token received from a previous `ListLakes` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListLakes` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListLakes` must match the call that provided the page token. */ // const pageToken = 'abc123' diff --git a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_sessions.js b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_sessions.js index 6800957e1c3..6b284c60ce4 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_sessions.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_sessions.js @@ -34,26 +34,26 @@ function main(parent) { */ // const parent = 'abc123' /** - * Optional. Maximum number of sessions to return. The service may return fewer than - * this value. If unspecified, at most 10 sessions will be returned. The - * maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of sessions to return. The service may return + * fewer than this value. If unspecified, at most 10 sessions will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. */ // const pageSize = 1234 /** - * Optional. Page token received from a previous `ListSessions` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListSessions` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListSessions` must match the call that provided the page * token. */ // const pageToken = 'abc123' /** - * Optional. Filter request. The following `mode` filter is supported to return only the - * sessions belonging to the requester when the mode is USER and return - * sessions of all the users when the mode is ADMIN. When no filter is sent - * default to USER mode. - * NOTE: When the mode is ADMIN, the requester should have - * `dataplex.environments.listAllSessions` permission to list all sessions, - * in absence of the permission, the request fails. + * Optional. Filter request. The following `mode` filter is supported to + * return only the sessions belonging to the requester when the mode is USER + * and return sessions of all the users when the mode is ADMIN. When no filter + * is sent default to USER mode. NOTE: When the mode is ADMIN, the requester + * should have `dataplex.environments.listAllSessions` permission to list all + * sessions, in absence of the permission, the request fails. * mode = ADMIN | USER */ // const filter = 'abc123' diff --git a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_tasks.js b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_tasks.js index 61506b45db2..63307d6d7af 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_tasks.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_tasks.js @@ -34,14 +34,14 @@ function main(parent) { */ // const parent = 'abc123' /** - * Optional. Maximum number of tasks to return. The service may return fewer than this - * value. If unspecified, at most 10 tasks will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of tasks to return. The service may return fewer + * than this value. If unspecified, at most 10 tasks will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. */ // const pageSize = 1234 /** - * Optional. Page token received from a previous `ListZones` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListZones` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListZones` must match the call that provided the page token. */ // const pageToken = 'abc123' diff --git a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_zone_actions.js b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_zone_actions.js index d55fd4712ba..907fc017e9b 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_zone_actions.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_zone_actions.js @@ -34,16 +34,16 @@ function main(parent) { */ // const parent = 'abc123' /** - * Optional. Maximum number of actions to return. The service may return fewer than this - * value. If unspecified, at most 10 actions will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of actions to return. The service may return fewer + * than this value. If unspecified, at most 10 actions will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. */ // const pageSize = 1234 /** - * Optional. Page token received from a previous `ListZoneActions` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters - * provided to `ListZoneActions` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListZoneActions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListZoneActions` must match the call that provided + * the page token. */ // const pageToken = 'abc123' diff --git a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_zones.js b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_zones.js index 4af5791ed2b..c68558da430 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_zones.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/dataplex_service.list_zones.js @@ -34,14 +34,14 @@ function main(parent) { */ // const parent = 'abc123' /** - * Optional. Maximum number of zones to return. The service may return fewer than this - * value. If unspecified, at most 10 zones will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of zones to return. The service may return fewer + * than this value. If unspecified, at most 10 zones will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. */ // const pageSize = 1234 /** - * Optional. Page token received from a previous `ListZones` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListZones` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListZones` must match the call that provided the page token. */ // const pageToken = 'abc123' diff --git a/packages/google-cloud-dataplex/samples/generated/v1/metadata_service.delete_entity.js b/packages/google-cloud-dataplex/samples/generated/v1/metadata_service.delete_entity.js index 90eddaa1cdd..afa02a95b96 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/metadata_service.delete_entity.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/metadata_service.delete_entity.js @@ -34,8 +34,8 @@ function main(name, etag) { */ // const name = 'abc123' /** - * Required. The etag associated with the entity, which can be retrieved with a - * GetEntity request. + * Required. The etag associated with the entity, which can be retrieved with + * a GetEntity request. */ // const etag = 'abc123' diff --git a/packages/google-cloud-dataplex/samples/generated/v1/metadata_service.list_entities.js b/packages/google-cloud-dataplex/samples/generated/v1/metadata_service.list_entities.js index 2f876cb7df0..84466cb144a 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/metadata_service.list_entities.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/metadata_service.list_entities.js @@ -38,9 +38,10 @@ function main(parent, view) { */ // const view = {} /** - * Optional. Maximum number of entities to return. The service may return fewer than - * this value. If unspecified, 100 entities will be returned by default. The - * maximum value is 500; larger values will will be truncated to 500. + * Optional. Maximum number of entities to return. The service may return + * fewer than this value. If unspecified, 100 entities will be returned by + * default. The maximum value is 500; larger values will will be truncated to + * 500. */ // const pageSize = 1234 /** @@ -51,8 +52,8 @@ function main(parent, view) { */ // const pageToken = 'abc123' /** - * Optional. The following filter parameters can be added to the URL to limit the - * entities returned by the API: + * Optional. The following filter parameters can be added to the URL to limit + * the entities returned by the API: * - Entity ID: ?filter="id=entityID" * - Asset ID: ?filter="asset=assetID" * - Data path ?filter="data_path=gs://my-bucket" diff --git a/packages/google-cloud-dataplex/samples/generated/v1/metadata_service.list_partitions.js b/packages/google-cloud-dataplex/samples/generated/v1/metadata_service.list_partitions.js index 5ac9dda4d10..04d1541692d 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/metadata_service.list_partitions.js +++ b/packages/google-cloud-dataplex/samples/generated/v1/metadata_service.list_partitions.js @@ -34,21 +34,22 @@ function main(parent) { */ // const parent = 'abc123' /** - * Optional. Maximum number of partitions to return. The service may return fewer than - * this value. If unspecified, 100 partitions will be returned by default. The - * maximum page size is 500; larger values will will be truncated to 500. + * Optional. Maximum number of partitions to return. The service may return + * fewer than this value. If unspecified, 100 partitions will be returned by + * default. The maximum page size is 500; larger values will will be truncated + * to 500. */ // const pageSize = 1234 /** - * Optional. Page token received from a previous `ListPartitions` call. Provide - * this to retrieve the subsequent page. When paginating, all other parameters - * provided to `ListPartitions` must match the call that provided the - * page token. + * Optional. Page token received from a previous `ListPartitions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListPartitions` must match the call that provided + * the page token. */ // const pageToken = 'abc123' /** - * Optional. Filter the partitions returned to the caller using a key value pair - * expression. Supported operators and syntax: + * Optional. Filter the partitions returned to the caller using a key value + * pair expression. Supported operators and syntax: * - logic operators: AND, OR * - comparison operators: <, >, >=, <= ,=, != * - LIKE operators: diff --git a/packages/google-cloud-dataplex/samples/generated/v1/snippet_metadata.google.cloud.dataplex.v1.json b/packages/google-cloud-dataplex/samples/generated/v1/snippet_metadata.google.cloud.dataplex.v1.json index 9d6a722e449..f026108b3b9 100644 --- a/packages/google-cloud-dataplex/samples/generated/v1/snippet_metadata.google.cloud.dataplex.v1.json +++ b/packages/google-cloud-dataplex/samples/generated/v1/snippet_metadata.google.cloud.dataplex.v1.json @@ -1746,7 +1746,7 @@ "segments": [ { "start": 25, - "end": 77, + "end": 78, "type": "FULL" } ], @@ -2074,7 +2074,7 @@ "segments": [ { "start": 25, - "end": 84, + "end": 85, "type": "FULL" } ], @@ -2262,7 +2262,7 @@ "segments": [ { "start": 25, - "end": 87, + "end": 88, "type": "FULL" } ], diff --git a/packages/google-cloud-dataplex/src/v1/content_service_client.ts b/packages/google-cloud-dataplex/src/v1/content_service_client.ts index 4f4b95b45a5..4cb43a4d8e2 100644 --- a/packages/google-cloud-dataplex/src/v1/content_service_client.ts +++ b/packages/google-cloud-dataplex/src/v1/content_service_client.ts @@ -125,6 +125,9 @@ export class ContentServiceClient { (typeof window !== 'undefined' && typeof window?.fetch === 'function'); opts = Object.assign({servicePath, port, clientConfig, fallback}, opts); + // Request numeric enum values if REST transport is used. + opts.numericEnums = true; + // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case. if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) { opts['scopes'] = staticMembers.scopes; @@ -1140,12 +1143,12 @@ export class ContentServiceClient { * Required. The resource name of the parent lake: * projects/{project_id}/locations/{location_id}/lakes/{lake_id} * @param {number} [request.pageSize] - * Optional. Maximum number of content to return. The service may return fewer than - * this value. If unspecified, at most 10 content will be returned. The + * Optional. Maximum number of content to return. The service may return fewer + * than this value. If unspecified, at most 10 content will be returned. The * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListContent` call. Provide this - * to retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListContent` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListContent` must match the call that provided the page * token. * @param {string} [request.filter] @@ -1248,12 +1251,12 @@ export class ContentServiceClient { * Required. The resource name of the parent lake: * projects/{project_id}/locations/{location_id}/lakes/{lake_id} * @param {number} [request.pageSize] - * Optional. Maximum number of content to return. The service may return fewer than - * this value. If unspecified, at most 10 content will be returned. The + * Optional. Maximum number of content to return. The service may return fewer + * than this value. If unspecified, at most 10 content will be returned. The * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListContent` call. Provide this - * to retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListContent` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListContent` must match the call that provided the page * token. * @param {string} [request.filter] @@ -1310,12 +1313,12 @@ export class ContentServiceClient { * Required. The resource name of the parent lake: * projects/{project_id}/locations/{location_id}/lakes/{lake_id} * @param {number} [request.pageSize] - * Optional. Maximum number of content to return. The service may return fewer than - * this value. If unspecified, at most 10 content will be returned. The + * Optional. Maximum number of content to return. The service may return fewer + * than this value. If unspecified, at most 10 content will be returned. The * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListContent` call. Provide this - * to retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListContent` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListContent` must match the call that provided the page * token. * @param {string} [request.filter] diff --git a/packages/google-cloud-dataplex/src/v1/dataplex_service_client.ts b/packages/google-cloud-dataplex/src/v1/dataplex_service_client.ts index 9740d49eed1..37e51088460 100644 --- a/packages/google-cloud-dataplex/src/v1/dataplex_service_client.ts +++ b/packages/google-cloud-dataplex/src/v1/dataplex_service_client.ts @@ -130,6 +130,9 @@ export class DataplexServiceClient { (typeof window !== 'undefined' && typeof window?.fetch === 'function'); opts = Object.assign({servicePath, port, clientConfig, fallback}, opts); + // Request numeric enum values if REST transport is used. + opts.numericEnums = true; + // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case. if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) { opts['scopes'] = staticMembers.scopes; @@ -3511,12 +3514,12 @@ export class DataplexServiceClient { * `projects/{project_number}/locations/{location_id}` * where `location_id` refers to a GCP region. * @param {number} [request.pageSize] - * Optional. Maximum number of Lakes to return. The service may return fewer than this - * value. If unspecified, at most 10 lakes will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of Lakes to return. The service may return fewer + * than this value. If unspecified, at most 10 lakes will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListLakes` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListLakes` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListLakes` must match the call that provided the page token. * @param {string} [request.filter] * Optional. Filter request. @@ -3611,12 +3614,12 @@ export class DataplexServiceClient { * `projects/{project_number}/locations/{location_id}` * where `location_id` refers to a GCP region. * @param {number} [request.pageSize] - * Optional. Maximum number of Lakes to return. The service may return fewer than this - * value. If unspecified, at most 10 lakes will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of Lakes to return. The service may return fewer + * than this value. If unspecified, at most 10 lakes will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListLakes` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListLakes` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListLakes` must match the call that provided the page token. * @param {string} [request.filter] * Optional. Filter request. @@ -3667,12 +3670,12 @@ export class DataplexServiceClient { * `projects/{project_number}/locations/{location_id}` * where `location_id` refers to a GCP region. * @param {number} [request.pageSize] - * Optional. Maximum number of Lakes to return. The service may return fewer than this - * value. If unspecified, at most 10 lakes will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of Lakes to return. The service may return fewer + * than this value. If unspecified, at most 10 lakes will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListLakes` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListLakes` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListLakes` must match the call that provided the page token. * @param {string} [request.filter] * Optional. Filter request. @@ -3721,14 +3724,14 @@ export class DataplexServiceClient { * Required. The resource name of the parent lake: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of actions to return. The service may return fewer than this - * value. If unspecified, at most 10 actions will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of actions to return. The service may return fewer + * than this value. If unspecified, at most 10 actions will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListLakeActions` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters - * provided to `ListLakeActions` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListLakeActions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListLakeActions` must match the call that provided + * the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -3819,14 +3822,14 @@ export class DataplexServiceClient { * Required. The resource name of the parent lake: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of actions to return. The service may return fewer than this - * value. If unspecified, at most 10 actions will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of actions to return. The service may return fewer + * than this value. If unspecified, at most 10 actions will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListLakeActions` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters - * provided to `ListLakeActions` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListLakeActions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListLakeActions` must match the call that provided + * the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} @@ -3871,14 +3874,14 @@ export class DataplexServiceClient { * Required. The resource name of the parent lake: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of actions to return. The service may return fewer than this - * value. If unspecified, at most 10 actions will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of actions to return. The service may return fewer + * than this value. If unspecified, at most 10 actions will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListLakeActions` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters - * provided to `ListLakeActions` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListLakeActions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListLakeActions` must match the call that provided + * the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} @@ -3922,12 +3925,12 @@ export class DataplexServiceClient { * Required. The resource name of the parent lake: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of zones to return. The service may return fewer than this - * value. If unspecified, at most 10 zones will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of zones to return. The service may return fewer + * than this value. If unspecified, at most 10 zones will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListZones` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListZones` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListZones` must match the call that provided the page token. * @param {string} [request.filter] * Optional. Filter request. @@ -4021,12 +4024,12 @@ export class DataplexServiceClient { * Required. The resource name of the parent lake: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of zones to return. The service may return fewer than this - * value. If unspecified, at most 10 zones will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of zones to return. The service may return fewer + * than this value. If unspecified, at most 10 zones will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListZones` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListZones` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListZones` must match the call that provided the page token. * @param {string} [request.filter] * Optional. Filter request. @@ -4076,12 +4079,12 @@ export class DataplexServiceClient { * Required. The resource name of the parent lake: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of zones to return. The service may return fewer than this - * value. If unspecified, at most 10 zones will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of zones to return. The service may return fewer + * than this value. If unspecified, at most 10 zones will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListZones` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListZones` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListZones` must match the call that provided the page token. * @param {string} [request.filter] * Optional. Filter request. @@ -4130,14 +4133,14 @@ export class DataplexServiceClient { * Required. The resource name of the parent zone: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of actions to return. The service may return fewer than this - * value. If unspecified, at most 10 actions will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of actions to return. The service may return fewer + * than this value. If unspecified, at most 10 actions will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListZoneActions` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters - * provided to `ListZoneActions` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListZoneActions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListZoneActions` must match the call that provided + * the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -4228,14 +4231,14 @@ export class DataplexServiceClient { * Required. The resource name of the parent zone: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of actions to return. The service may return fewer than this - * value. If unspecified, at most 10 actions will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of actions to return. The service may return fewer + * than this value. If unspecified, at most 10 actions will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListZoneActions` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters - * provided to `ListZoneActions` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListZoneActions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListZoneActions` must match the call that provided + * the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} @@ -4280,14 +4283,14 @@ export class DataplexServiceClient { * Required. The resource name of the parent zone: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of actions to return. The service may return fewer than this - * value. If unspecified, at most 10 actions will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of actions to return. The service may return fewer + * than this value. If unspecified, at most 10 actions will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListZoneActions` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters - * provided to `ListZoneActions` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListZoneActions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListZoneActions` must match the call that provided + * the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} @@ -4331,12 +4334,12 @@ export class DataplexServiceClient { * Required. The resource name of the parent zone: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of asset to return. The service may return fewer than - * this value. If unspecified, at most 10 assets will be returned. The + * Optional. Maximum number of asset to return. The service may return fewer + * than this value. If unspecified, at most 10 assets will be returned. The * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListAssets` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListAssets` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListAssets` must match the call that provided the page * token. * @param {string} [request.filter] @@ -4433,12 +4436,12 @@ export class DataplexServiceClient { * Required. The resource name of the parent zone: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of asset to return. The service may return fewer than - * this value. If unspecified, at most 10 assets will be returned. The + * Optional. Maximum number of asset to return. The service may return fewer + * than this value. If unspecified, at most 10 assets will be returned. The * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListAssets` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListAssets` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListAssets` must match the call that provided the page * token. * @param {string} [request.filter] @@ -4489,12 +4492,12 @@ export class DataplexServiceClient { * Required. The resource name of the parent zone: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of asset to return. The service may return fewer than - * this value. If unspecified, at most 10 assets will be returned. The + * Optional. Maximum number of asset to return. The service may return fewer + * than this value. If unspecified, at most 10 assets will be returned. The * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListAssets` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListAssets` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListAssets` must match the call that provided the page * token. * @param {string} [request.filter] @@ -4544,14 +4547,14 @@ export class DataplexServiceClient { * Required. The resource name of the parent asset: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of actions to return. The service may return fewer than this - * value. If unspecified, at most 10 actions will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of actions to return. The service may return fewer + * than this value. If unspecified, at most 10 actions will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListAssetActions` call. Provide this - * to retrieve the subsequent page. When paginating, all other parameters - * provided to `ListAssetActions` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListAssetActions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListAssetActions` must match the call that provided + * the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -4642,14 +4645,14 @@ export class DataplexServiceClient { * Required. The resource name of the parent asset: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of actions to return. The service may return fewer than this - * value. If unspecified, at most 10 actions will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of actions to return. The service may return fewer + * than this value. If unspecified, at most 10 actions will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListAssetActions` call. Provide this - * to retrieve the subsequent page. When paginating, all other parameters - * provided to `ListAssetActions` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListAssetActions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListAssetActions` must match the call that provided + * the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} @@ -4694,14 +4697,14 @@ export class DataplexServiceClient { * Required. The resource name of the parent asset: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of actions to return. The service may return fewer than this - * value. If unspecified, at most 10 actions will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of actions to return. The service may return fewer + * than this value. If unspecified, at most 10 actions will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListAssetActions` call. Provide this - * to retrieve the subsequent page. When paginating, all other parameters - * provided to `ListAssetActions` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListAssetActions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListAssetActions` must match the call that provided + * the page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} @@ -4745,12 +4748,12 @@ export class DataplexServiceClient { * Required. The resource name of the parent lake: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of tasks to return. The service may return fewer than this - * value. If unspecified, at most 10 tasks will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of tasks to return. The service may return fewer + * than this value. If unspecified, at most 10 tasks will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListZones` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListZones` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListZones` must match the call that provided the page token. * @param {string} [request.filter] * Optional. Filter request. @@ -4844,12 +4847,12 @@ export class DataplexServiceClient { * Required. The resource name of the parent lake: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of tasks to return. The service may return fewer than this - * value. If unspecified, at most 10 tasks will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of tasks to return. The service may return fewer + * than this value. If unspecified, at most 10 tasks will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListZones` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListZones` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListZones` must match the call that provided the page token. * @param {string} [request.filter] * Optional. Filter request. @@ -4899,12 +4902,12 @@ export class DataplexServiceClient { * Required. The resource name of the parent lake: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of tasks to return. The service may return fewer than this - * value. If unspecified, at most 10 tasks will be returned. The maximum - * value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of tasks to return. The service may return fewer + * than this value. If unspecified, at most 10 tasks will be returned. The + * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListZones` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListZones` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListZones` must match the call that provided the page token. * @param {string} [request.filter] * Optional. Filter request. @@ -4953,12 +4956,12 @@ export class DataplexServiceClient { * Required. The resource name of the parent environment: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of jobs to return. The service may return fewer than - * this value. If unspecified, at most 10 jobs will be returned. The + * Optional. Maximum number of jobs to return. The service may return fewer + * than this value. If unspecified, at most 10 jobs will be returned. The * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListJobs` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListJobs` call. Provide this + * to retrieve the subsequent page. When paginating, all other parameters * provided to `ListJobs` must match the call that provided the page * token. * @param {object} [options] @@ -5049,12 +5052,12 @@ export class DataplexServiceClient { * Required. The resource name of the parent environment: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of jobs to return. The service may return fewer than - * this value. If unspecified, at most 10 jobs will be returned. The + * Optional. Maximum number of jobs to return. The service may return fewer + * than this value. If unspecified, at most 10 jobs will be returned. The * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListJobs` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListJobs` call. Provide this + * to retrieve the subsequent page. When paginating, all other parameters * provided to `ListJobs` must match the call that provided the page * token. * @param {object} [options] @@ -5101,12 +5104,12 @@ export class DataplexServiceClient { * Required. The resource name of the parent environment: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of jobs to return. The service may return fewer than - * this value. If unspecified, at most 10 jobs will be returned. The + * Optional. Maximum number of jobs to return. The service may return fewer + * than this value. If unspecified, at most 10 jobs will be returned. The * maximum value is 1000; values above 1000 will be coerced to 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListJobs` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListJobs` call. Provide this + * to retrieve the subsequent page. When paginating, all other parameters * provided to `ListJobs` must match the call that provided the page * token. * @param {object} [options] @@ -5152,14 +5155,15 @@ export class DataplexServiceClient { * Required. The resource name of the parent lake: * `projects/{project_id}/locations/{location_id}/lakes/{lake_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of environments to return. The service may return fewer than - * this value. If unspecified, at most 10 environments will be returned. The - * maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of environments to return. The service may return + * fewer than this value. If unspecified, at most 10 environments will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListEnvironments` call. Provide this - * to retrieve the subsequent page. When paginating, all other parameters - * provided to `ListEnvironments` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListEnvironments` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListEnvironments` must match the call that provided + * the page token. * @param {string} [request.filter] * Optional. Filter request. * @param {string} [request.orderBy] @@ -5260,14 +5264,15 @@ export class DataplexServiceClient { * Required. The resource name of the parent lake: * `projects/{project_id}/locations/{location_id}/lakes/{lake_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of environments to return. The service may return fewer than - * this value. If unspecified, at most 10 environments will be returned. The - * maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of environments to return. The service may return + * fewer than this value. If unspecified, at most 10 environments will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListEnvironments` call. Provide this - * to retrieve the subsequent page. When paginating, all other parameters - * provided to `ListEnvironments` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListEnvironments` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListEnvironments` must match the call that provided + * the page token. * @param {string} [request.filter] * Optional. Filter request. * @param {string} [request.orderBy] @@ -5316,14 +5321,15 @@ export class DataplexServiceClient { * Required. The resource name of the parent lake: * `projects/{project_id}/locations/{location_id}/lakes/{lake_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of environments to return. The service may return fewer than - * this value. If unspecified, at most 10 environments will be returned. The - * maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of environments to return. The service may return + * fewer than this value. If unspecified, at most 10 environments will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListEnvironments` call. Provide this - * to retrieve the subsequent page. When paginating, all other parameters - * provided to `ListEnvironments` must match the call that provided the page - * token. + * Optional. Page token received from a previous `ListEnvironments` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListEnvironments` must match the call that provided + * the page token. * @param {string} [request.filter] * Optional. Filter request. * @param {string} [request.orderBy] @@ -5371,22 +5377,22 @@ export class DataplexServiceClient { * Required. The resource name of the parent environment: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of sessions to return. The service may return fewer than - * this value. If unspecified, at most 10 sessions will be returned. The - * maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of sessions to return. The service may return + * fewer than this value. If unspecified, at most 10 sessions will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListSessions` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListSessions` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListSessions` must match the call that provided the page * token. * @param {string} [request.filter] - * Optional. Filter request. The following `mode` filter is supported to return only the - * sessions belonging to the requester when the mode is USER and return - * sessions of all the users when the mode is ADMIN. When no filter is sent - * default to USER mode. - * NOTE: When the mode is ADMIN, the requester should have - * `dataplex.environments.listAllSessions` permission to list all sessions, - * in absence of the permission, the request fails. + * Optional. Filter request. The following `mode` filter is supported to + * return only the sessions belonging to the requester when the mode is USER + * and return sessions of all the users when the mode is ADMIN. When no filter + * is sent default to USER mode. NOTE: When the mode is ADMIN, the requester + * should have `dataplex.environments.listAllSessions` permission to list all + * sessions, in absence of the permission, the request fails. * * mode = ADMIN | USER * @param {object} [options] @@ -5479,22 +5485,22 @@ export class DataplexServiceClient { * Required. The resource name of the parent environment: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of sessions to return. The service may return fewer than - * this value. If unspecified, at most 10 sessions will be returned. The - * maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of sessions to return. The service may return + * fewer than this value. If unspecified, at most 10 sessions will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListSessions` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListSessions` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListSessions` must match the call that provided the page * token. * @param {string} [request.filter] - * Optional. Filter request. The following `mode` filter is supported to return only the - * sessions belonging to the requester when the mode is USER and return - * sessions of all the users when the mode is ADMIN. When no filter is sent - * default to USER mode. - * NOTE: When the mode is ADMIN, the requester should have - * `dataplex.environments.listAllSessions` permission to list all sessions, - * in absence of the permission, the request fails. + * Optional. Filter request. The following `mode` filter is supported to + * return only the sessions belonging to the requester when the mode is USER + * and return sessions of all the users when the mode is ADMIN. When no filter + * is sent default to USER mode. NOTE: When the mode is ADMIN, the requester + * should have `dataplex.environments.listAllSessions` permission to list all + * sessions, in absence of the permission, the request fails. * * mode = ADMIN | USER * @param {object} [options] @@ -5541,22 +5547,22 @@ export class DataplexServiceClient { * Required. The resource name of the parent environment: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of sessions to return. The service may return fewer than - * this value. If unspecified, at most 10 sessions will be returned. The - * maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of sessions to return. The service may return + * fewer than this value. If unspecified, at most 10 sessions will be + * returned. The maximum value is 1000; values above 1000 will be coerced to + * 1000. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListSessions` call. Provide this to - * retrieve the subsequent page. When paginating, all other parameters + * Optional. Page token received from a previous `ListSessions` call. Provide + * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListSessions` must match the call that provided the page * token. * @param {string} [request.filter] - * Optional. Filter request. The following `mode` filter is supported to return only the - * sessions belonging to the requester when the mode is USER and return - * sessions of all the users when the mode is ADMIN. When no filter is sent - * default to USER mode. - * NOTE: When the mode is ADMIN, the requester should have - * `dataplex.environments.listAllSessions` permission to list all sessions, - * in absence of the permission, the request fails. + * Optional. Filter request. The following `mode` filter is supported to + * return only the sessions belonging to the requester when the mode is USER + * and return sessions of all the users when the mode is ADMIN. When no filter + * is sent default to USER mode. NOTE: When the mode is ADMIN, the requester + * should have `dataplex.environments.listAllSessions` permission to list all + * sessions, in absence of the permission, the request fails. * * mode = ADMIN | USER * @param {object} [options] diff --git a/packages/google-cloud-dataplex/src/v1/metadata_service_client.ts b/packages/google-cloud-dataplex/src/v1/metadata_service_client.ts index df7a6cbe206..cc5b444fb80 100644 --- a/packages/google-cloud-dataplex/src/v1/metadata_service_client.ts +++ b/packages/google-cloud-dataplex/src/v1/metadata_service_client.ts @@ -126,6 +126,9 @@ export class MetadataServiceClient { (typeof window !== 'undefined' && typeof window?.fetch === 'function'); opts = Object.assign({servicePath, port, clientConfig, fallback}, opts); + // Request numeric enum values if REST transport is used. + opts.numericEnums = true; + // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case. if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) { opts['scopes'] = staticMembers.scopes; @@ -682,8 +685,8 @@ export class MetadataServiceClient { * Required. The resource name of the entity: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`. * @param {string} request.etag - * Required. The etag associated with the entity, which can be retrieved with a - * {@link |GetEntity} request. + * Required. The etag associated with the entity, which can be retrieved with + * a {@link |GetEntity} request. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. @@ -1143,17 +1146,18 @@ export class MetadataServiceClient { * @param {google.cloud.dataplex.v1.ListEntitiesRequest.EntityView} request.view * Required. Specify the entity view to make a partial list request. * @param {number} [request.pageSize] - * Optional. Maximum number of entities to return. The service may return fewer than - * this value. If unspecified, 100 entities will be returned by default. The - * maximum value is 500; larger values will will be truncated to 500. + * Optional. Maximum number of entities to return. The service may return + * fewer than this value. If unspecified, 100 entities will be returned by + * default. The maximum value is 500; larger values will will be truncated to + * 500. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListEntities` call. Provide * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListEntities` must match the call that provided the * page token. * @param {string} [request.filter] - * Optional. The following filter parameters can be added to the URL to limit the - * entities returned by the API: + * Optional. The following filter parameters can be added to the URL to limit + * the entities returned by the API: * * - Entity ID: ?filter="id=entityID" * - Asset ID: ?filter="asset=assetID" @@ -1252,17 +1256,18 @@ export class MetadataServiceClient { * @param {google.cloud.dataplex.v1.ListEntitiesRequest.EntityView} request.view * Required. Specify the entity view to make a partial list request. * @param {number} [request.pageSize] - * Optional. Maximum number of entities to return. The service may return fewer than - * this value. If unspecified, 100 entities will be returned by default. The - * maximum value is 500; larger values will will be truncated to 500. + * Optional. Maximum number of entities to return. The service may return + * fewer than this value. If unspecified, 100 entities will be returned by + * default. The maximum value is 500; larger values will will be truncated to + * 500. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListEntities` call. Provide * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListEntities` must match the call that provided the * page token. * @param {string} [request.filter] - * Optional. The following filter parameters can be added to the URL to limit the - * entities returned by the API: + * Optional. The following filter parameters can be added to the URL to limit + * the entities returned by the API: * * - Entity ID: ?filter="id=entityID" * - Asset ID: ?filter="asset=assetID" @@ -1315,17 +1320,18 @@ export class MetadataServiceClient { * @param {google.cloud.dataplex.v1.ListEntitiesRequest.EntityView} request.view * Required. Specify the entity view to make a partial list request. * @param {number} [request.pageSize] - * Optional. Maximum number of entities to return. The service may return fewer than - * this value. If unspecified, 100 entities will be returned by default. The - * maximum value is 500; larger values will will be truncated to 500. + * Optional. Maximum number of entities to return. The service may return + * fewer than this value. If unspecified, 100 entities will be returned by + * default. The maximum value is 500; larger values will will be truncated to + * 500. * @param {string} [request.pageToken] * Optional. Page token received from a previous `ListEntities` call. Provide * this to retrieve the subsequent page. When paginating, all other parameters * provided to `ListEntities` must match the call that provided the * page token. * @param {string} [request.filter] - * Optional. The following filter parameters can be added to the URL to limit the - * entities returned by the API: + * Optional. The following filter parameters can be added to the URL to limit + * the entities returned by the API: * * - Entity ID: ?filter="id=entityID" * - Asset ID: ?filter="asset=assetID" @@ -1375,17 +1381,18 @@ export class MetadataServiceClient { * Required. The resource name of the parent entity: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of partitions to return. The service may return fewer than - * this value. If unspecified, 100 partitions will be returned by default. The - * maximum page size is 500; larger values will will be truncated to 500. + * Optional. Maximum number of partitions to return. The service may return + * fewer than this value. If unspecified, 100 partitions will be returned by + * default. The maximum page size is 500; larger values will will be truncated + * to 500. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListPartitions` call. Provide - * this to retrieve the subsequent page. When paginating, all other parameters - * provided to `ListPartitions` must match the call that provided the - * page token. + * Optional. Page token received from a previous `ListPartitions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListPartitions` must match the call that provided + * the page token. * @param {string} [request.filter] - * Optional. Filter the partitions returned to the caller using a key value pair - * expression. Supported operators and syntax: + * Optional. Filter the partitions returned to the caller using a key value + * pair expression. Supported operators and syntax: * * - logic operators: AND, OR * - comparison operators: <, >, >=, <= ,=, != @@ -1499,17 +1506,18 @@ export class MetadataServiceClient { * Required. The resource name of the parent entity: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of partitions to return. The service may return fewer than - * this value. If unspecified, 100 partitions will be returned by default. The - * maximum page size is 500; larger values will will be truncated to 500. + * Optional. Maximum number of partitions to return. The service may return + * fewer than this value. If unspecified, 100 partitions will be returned by + * default. The maximum page size is 500; larger values will will be truncated + * to 500. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListPartitions` call. Provide - * this to retrieve the subsequent page. When paginating, all other parameters - * provided to `ListPartitions` must match the call that provided the - * page token. + * Optional. Page token received from a previous `ListPartitions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListPartitions` must match the call that provided + * the page token. * @param {string} [request.filter] - * Optional. Filter the partitions returned to the caller using a key value pair - * expression. Supported operators and syntax: + * Optional. Filter the partitions returned to the caller using a key value + * pair expression. Supported operators and syntax: * * - logic operators: AND, OR * - comparison operators: <, >, >=, <= ,=, != @@ -1571,17 +1579,18 @@ export class MetadataServiceClient { * Required. The resource name of the parent entity: * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`. * @param {number} [request.pageSize] - * Optional. Maximum number of partitions to return. The service may return fewer than - * this value. If unspecified, 100 partitions will be returned by default. The - * maximum page size is 500; larger values will will be truncated to 500. + * Optional. Maximum number of partitions to return. The service may return + * fewer than this value. If unspecified, 100 partitions will be returned by + * default. The maximum page size is 500; larger values will will be truncated + * to 500. * @param {string} [request.pageToken] - * Optional. Page token received from a previous `ListPartitions` call. Provide - * this to retrieve the subsequent page. When paginating, all other parameters - * provided to `ListPartitions` must match the call that provided the - * page token. + * Optional. Page token received from a previous `ListPartitions` call. + * Provide this to retrieve the subsequent page. When paginating, all other + * parameters provided to `ListPartitions` must match the call that provided + * the page token. * @param {string} [request.filter] - * Optional. Filter the partitions returned to the caller using a key value pair - * expression. Supported operators and syntax: + * Optional. Filter the partitions returned to the caller using a key value + * pair expression. Supported operators and syntax: * * - logic operators: AND, OR * - comparison operators: <, >, >=, <= ,=, !=