diff --git a/Dataplex/metadata/V1/Catalog.php b/Dataplex/metadata/V1/Catalog.php index 96c8b3161408..6db043ed3908 100644 --- a/Dataplex/metadata/V1/Catalog.php +++ b/Dataplex/metadata/V1/Catalog.php @@ -17,6 +17,7 @@ public static function initOnce() { \GPBMetadata\Google\Api\Annotations::initOnce(); \GPBMetadata\Google\Api\Client::initOnce(); \GPBMetadata\Google\Api\FieldBehavior::initOnce(); + \GPBMetadata\Google\Api\FieldInfo::initOnce(); \GPBMetadata\Google\Api\Resource::initOnce(); \GPBMetadata\Google\Cloud\Dataplex\V1\Service::initOnce(); \GPBMetadata\Google\Longrunning\Operations::initOnce(); @@ -26,8 +27,8 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\Timestamp::initOnce(); $pool->internalAddGeneratedFile( ' -õn -&google/cloud/dataplex/v1/catalog.protogoogle.cloud.dataplex.v1google/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto&google/cloud/dataplex/v1/service.proto#google/longrunning/operations.protogoogle/protobuf/empty.proto google/protobuf/field_mask.protogoogle/protobuf/struct.protogoogle/protobuf/timestamp.proto"Ó +ûŒ +&google/cloud/dataplex/v1/catalog.protogoogle.cloud.dataplex.v1google/api/client.protogoogle/api/field_behavior.protogoogle/api/field_info.protogoogle/api/resource.proto&google/cloud/dataplex/v1/service.proto#google/longrunning/operations.protogoogle/protobuf/empty.proto google/protobuf/field_mask.protogoogle/protobuf/struct.protogoogle/protobuf/timestamp.proto"Ó AspectType8 name ( B*àAúA$ @@ -127,11 +128,12 @@ public static function initOnce() { create_time ( 2.google.protobuf.TimestampBàA4 update_time ( 2.google.protobuf.TimestampBàA* data ( 2.google.protobuf.StructBàAB - aspect_source ( 2&.google.cloud.dataplex.v1.AspectSourceBàA"p + aspect_source ( 2&.google.cloud.dataplex.v1.AspectSourceBàA"† AspectSource/ create_time ( 2.google.protobuf.Timestamp/ - update_time ( 2.google.protobuf.Timestamp"Ä + update_time ( 2.google.protobuf.Timestamp + data_version ( "Ä Entry name ( BàA @@ -290,9 +292,10 @@ public static function initOnce() { aspect_types ( BàA paths ( BàA4 entry ( B%àAúA -dataplex.googleapis.com/Entry"™ -SearchEntriesRequest -name ( BàA +dataplex.googleapis.com/Entry"¿ +SearchEntriesRequest7 +name ( B)àAúA# +!locations.googleapis.com/Location query ( BàA page_size (BàA @@ -310,7 +313,101 @@ public static function initOnce() { total_size ( next_page_token (  - unreachable ( *Q + unreachable ( "‚ + +ImportItem. +entry ( 2.google.cloud.dataplex.v1.Entry/ + update_mask ( 2.google.protobuf.FieldMask + aspect_keys ( "Ñ +CreateMetadataJobRequest9 +parent ( B)àAúA# +!locations.googleapis.com/Location@ + metadata_job ( 2%.google.cloud.dataplex.v1.MetadataJobBàA +metadata_job_id ( BàA + validate_only (BàA"R +GetMetadataJobRequest9 +name ( B+àAúA% +#dataplex.googleapis.com/MetadataJob"± +ListMetadataJobsRequest9 +parent ( B)àAúA# +!locations.googleapis.com/Location + page_size (BàA + +page_token ( BàA +filter ( BàA +order_by ( BàA" +ListMetadataJobsResponse< + metadata_jobs ( 2%.google.cloud.dataplex.v1.MetadataJob +next_page_token (  +unreachable_locations ( "U +CancelMetadataJobRequest9 +name ( B+àAúA% +#dataplex.googleapis.com/MetadataJob"Ë + MetadataJob +name ( BàAàA +uid ( B àAâŒÏ×4 + create_time ( 2.google.protobuf.TimestampBàA4 + update_time ( 2.google.protobuf.TimestampBàAF +labels ( 21.google.cloud.dataplex.v1.MetadataJob.LabelsEntryBàA= +type (2*.google.cloud.dataplex.v1.MetadataJob.TypeBàAJ + import_specd ( 23.google.cloud.dataplex.v1.MetadataJob.ImportJobSpecHT + import_resultÈ ( 25.google.cloud.dataplex.v1.MetadataJob.ImportJobResultBàAHA +status ( 2,.google.cloud.dataplex.v1.MetadataJob.StatusBàAá +ImportJobResult +deleted_entries (BàA +updated_entries (BàA +created_entries (BàA +unchanged_entries (BàA +recreated_entries (BàA4 + update_time ( 2.google.protobuf.TimestampBàA© + ImportJobSpec +source_storage_uri ( BàA; +source_create_time ( 2.google.protobuf.TimestampBàAV +scope ( 2B.google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.ImportJobScopeBàAZ +entry_sync_mode (2<.google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncModeBàA[ +aspect_sync_mode (2<.google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncModeBàAT + log_level (2<.google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.LogLevelBàAÔ +ImportJobScope@ + entry_groups ( B*àAúA$ +"dataplex.googleapis.com/EntryGroup> + entry_types ( B)àAúA# +!dataplex.googleapis.com/EntryType@ + aspect_types ( B*àAúA$ +"dataplex.googleapis.com/AspectType"@ +SyncMode +SYNC_MODE_UNSPECIFIED +FULL + INCREMENTAL": +LogLevel +LOG_LEVEL_UNSPECIFIED +DEBUG +INFOÊ +StatusF +state (22.google.cloud.dataplex.v1.MetadataJob.Status.StateBàA +message ( BàA +completion_percent (BàA4 + update_time ( 2.google.protobuf.TimestampBàA"Š +State +STATE_UNSPECIFIED + +QUEUED +RUNNING + CANCELING +CANCELED + SUCCEEDED + +FAILED +SUCCEEDED_WITH_ERRORS- + LabelsEntry +key (  +value ( :8"( +Type +TYPE_UNSPECIFIED + +IMPORT:lêAi +#dataplex.googleapis.com/MetadataJobBprojects/{project}/locations/{location}/metadataJobs/{metadataJob}B +specB +result*Q EntryView ENTRY_VIEW_UNSPECIFIED BASIC @@ -321,7 +418,7 @@ public static function initOnce() { TransferStatus TRANSFER_STATUS_UNSPECIFIED TRANSFER_STATUS_MIGRATED -TRANSFER_STATUS_TRANSFERRED2‚# +TRANSFER_STATUS_TRANSFERRED2•) CatalogServiceê CreateEntryType0.google.cloud.dataplex.v1.CreateEntryTypeRequest.google.longrunning.Operation"…ÊA EntryTypeOperationMetadataÚAparent,entry_type,entry_type_id‚Óä“<"./v1/{parent=projects/*/locations/*}/entryTypes: @@ -360,7 +457,12 @@ public static function initOnce() { GetEntry).google.cloud.dataplex.v1.GetEntryRequest.google.cloud.dataplex.v1.Entry"IÚAname‚Óä“<:/v1/{name=projects/*/locations/*/entryGroups/*/entries/**}“ LookupEntry,.google.cloud.dataplex.v1.LookupEntryRequest.google.cloud.dataplex.v1.Entry"5‚Óä“/-/v1/{name=projects/*/locations/*}:lookupEntry¶ SearchEntries..google.cloud.dataplex.v1.SearchEntriesRequest/.google.cloud.dataplex.v1.SearchEntriesResponse"DÚA -name,query‚Óä“1"//v1/{name=projects/*/locations/*}:searchEntriesKÊAdataplex.googleapis.comÒA.https://www.googleapis.com/auth/cloud-platformB¼ +name,query‚Óä“1"//v1/{name=projects/*/locations/*}:searchEntriesø +CreateMetadataJob2.google.cloud.dataplex.v1.CreateMetadataJobRequest.google.longrunning.Operation"ÊA + MetadataJobOperationMetadataÚA#parent,metadata_job,metadata_job_id‚Óä“@"0/v1/{parent=projects/*/locations/*}/metadataJobs: metadata_job© +GetMetadataJob/.google.cloud.dataplex.v1.GetMetadataJobRequest%.google.cloud.dataplex.v1.MetadataJob"?ÚAname‚Óä“20/v1/{name=projects/*/locations/*/metadataJobs/*}¼ +ListMetadataJobs1.google.cloud.dataplex.v1.ListMetadataJobsRequest2.google.cloud.dataplex.v1.ListMetadataJobsResponse"AÚAparent‚Óä“20/v1/{parent=projects/*/locations/*}/metadataJobsª +CancelMetadataJob2.google.cloud.dataplex.v1.CancelMetadataJobRequest.google.protobuf.Empty"IÚAname‚Óä“<"7/v1/{name=projects/*/locations/*/metadataJobs/*}:cancel:*KÊAdataplex.googleapis.comÒA.https://www.googleapis.com/auth/cloud-platformB¼ com.google.cloud.dataplex.v1B CatalogProtoPZ8cloud.google.com/go/dataplex/apiv1/dataplexpb;dataplexpbªGoogle.Cloud.Dataplex.V1ÊGoogle\\Cloud\\Dataplex\\V1êGoogle::Cloud::Dataplex::V1bproto3' , true); diff --git a/Dataplex/metadata/V1/DataDiscovery.php b/Dataplex/metadata/V1/DataDiscovery.php new file mode 100644 index 000000000000..655a6616d526 Binary files /dev/null and b/Dataplex/metadata/V1/DataDiscovery.php differ diff --git a/Dataplex/metadata/V1/DataQuality.php b/Dataplex/metadata/V1/DataQuality.php index a0ce2465cea5..2434bfd51f01 100644 Binary files a/Dataplex/metadata/V1/DataQuality.php and b/Dataplex/metadata/V1/DataQuality.php differ diff --git a/Dataplex/metadata/V1/Datascans.php b/Dataplex/metadata/V1/Datascans.php index 1b5cb8b5234d..3c7017edb1c8 100644 Binary files a/Dataplex/metadata/V1/Datascans.php and b/Dataplex/metadata/V1/Datascans.php differ diff --git a/Dataplex/metadata/V1/Logs.php b/Dataplex/metadata/V1/Logs.php index f8a7f110a7f9..68628a0779ce 100644 Binary files a/Dataplex/metadata/V1/Logs.php and b/Dataplex/metadata/V1/Logs.php differ diff --git a/Dataplex/samples/V1/CatalogServiceClient/cancel_metadata_job.php b/Dataplex/samples/V1/CatalogServiceClient/cancel_metadata_job.php new file mode 100644 index 000000000000..243883ec10e3 --- /dev/null +++ b/Dataplex/samples/V1/CatalogServiceClient/cancel_metadata_job.php @@ -0,0 +1,75 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + $catalogServiceClient->cancelMetadataJob($request); + printf('Call completed successfully.' . PHP_EOL); + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } +} + +/** + * Helper to execute the sample. + * + * This sample has been automatically generated and should be regarded as a code + * template only. It will require modifications to work: + * - It may require correct/in-range values for request initialization. + * - It may require specifying regional endpoints when creating the service client, + * please see the apiEndpoint client configuration option for more details. + */ +function callSample(): void +{ + $formattedName = CatalogServiceClient::metadataJobName('[PROJECT]', '[LOCATION]', '[METADATAJOB]'); + + cancel_metadata_job_sample($formattedName); +} +// [END dataplex_v1_generated_CatalogService_CancelMetadataJob_sync] diff --git a/Dataplex/samples/V1/CatalogServiceClient/create_aspect_type.php b/Dataplex/samples/V1/CatalogServiceClient/create_aspect_type.php index e41837c7836f..4f781103e708 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/create_aspect_type.php +++ b/Dataplex/samples/V1/CatalogServiceClient/create_aspect_type.php @@ -32,19 +32,31 @@ use Google\Rpc\Status; /** - * Creates an AspectType + * Creates an AspectType. * * @param string $formattedParent The resource name of the AspectType, of the form: * projects/{project_number}/locations/{location_id} - * where `location_id` refers to a GCP region. Please see + * where `location_id` refers to a Google Cloud region. Please see * {@see CatalogServiceClient::locationName()} for help formatting this field. * @param string $aspectTypeId AspectType identifier. * @param string $aspectTypeMetadataTemplateName The name of the field. * @param string $aspectTypeMetadataTemplateType The datatype of this field. The following values are supported: - * Primitive types (string, integer, boolean, double, datetime); datetime - * must be of the format RFC3339 UTC "Zulu" (Examples: - * "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex - * types (enum, array, map, record). + * + * Primitive types: + * + * * string + * * integer + * * boolean + * * double + * * datetime. Must be of the format RFC3339 UTC "Zulu" (Examples: + * "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). + * + * Complex types: + * + * * enum + * * array + * * map + * * record */ function create_aspect_type_sample( string $formattedParent, diff --git a/Dataplex/samples/V1/CatalogServiceClient/create_entry.php b/Dataplex/samples/V1/CatalogServiceClient/create_entry.php index b507dcca259d..71181a062312 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/create_entry.php +++ b/Dataplex/samples/V1/CatalogServiceClient/create_entry.php @@ -36,25 +36,27 @@ * {@see CatalogServiceClient::entryGroupName()} for help formatting this field. * @param string $entryId Entry identifier. It has to be unique within an Entry Group. * - * Entries corresponding to Google Cloud resources use Entry ID format based - * on Full Resource Names - * (https://cloud.google.com/apis/design/resource_names#full_resource_name). - * The format is a Full Resource Name of the resource without the - * prefix double slashes in the API Service Name part of Full Resource Name. - * This allows retrieval of entries using their associated resource name. + * Entries corresponding to Google Cloud resources use an Entry ID format + * based on [full resource + * names](https://cloud.google.com/apis/design/resource_names#full_resource_name). + * The format is a full resource name of the resource without the + * prefix double slashes in the API service name part of the full resource + * name. This allows retrieval of entries using their associated resource + * name. * - * For example if the Full Resource Name of a resource is + * For example, if the full resource name of a resource is * `//library.googleapis.com/shelves/shelf1/books/book2`, * then the suggested entry_id is * `library.googleapis.com/shelves/shelf1/books/book2`. * * It is also suggested to follow the same convention for entries - * corresponding to resources from other providers or systems than Google + * corresponding to resources from providers or systems other than Google * Cloud. * * The maximum size of the field is 4000 characters. - * @param string $entryEntryType Immutable. The resource name of the EntryType used to create this - * Entry. + * @param string $entryEntryType Immutable. The relative resource name of the entry type that was + * used to create this entry, in the format + * `projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}`. */ function create_entry_sample( string $formattedParent, diff --git a/Dataplex/samples/V1/CatalogServiceClient/create_entry_group.php b/Dataplex/samples/V1/CatalogServiceClient/create_entry_group.php index b9d9e9576347..27f170aa1b55 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/create_entry_group.php +++ b/Dataplex/samples/V1/CatalogServiceClient/create_entry_group.php @@ -31,7 +31,7 @@ use Google\Rpc\Status; /** - * Creates an EntryGroup + * Creates an EntryGroup. * * @param string $formattedParent The resource name of the entryGroup, of the form: * projects/{project_number}/locations/{location_id} diff --git a/Dataplex/samples/V1/CatalogServiceClient/create_entry_type.php b/Dataplex/samples/V1/CatalogServiceClient/create_entry_type.php index 126853c88d30..acafec6d161f 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/create_entry_type.php +++ b/Dataplex/samples/V1/CatalogServiceClient/create_entry_type.php @@ -31,11 +31,11 @@ use Google\Rpc\Status; /** - * Creates an EntryType + * Creates an EntryType. * * @param string $formattedParent The resource name of the EntryType, of the form: * projects/{project_number}/locations/{location_id} - * where `location_id` refers to a GCP region. Please see + * where `location_id` refers to a Google Cloud region. Please see * {@see CatalogServiceClient::locationName()} for help formatting this field. * @param string $entryTypeId EntryType identifier. */ diff --git a/Dataplex/samples/V1/CatalogServiceClient/create_metadata_job.php b/Dataplex/samples/V1/CatalogServiceClient/create_metadata_job.php new file mode 100644 index 000000000000..fae768c4f4c5 --- /dev/null +++ b/Dataplex/samples/V1/CatalogServiceClient/create_metadata_job.php @@ -0,0 +1,91 @@ +setType($metadataJobType); + $request = (new CreateMetadataJobRequest()) + ->setParent($formattedParent) + ->setMetadataJob($metadataJob); + + // Call the API and handle any network failures. + try { + /** @var OperationResponse $response */ + $response = $catalogServiceClient->createMetadataJob($request); + $response->pollUntilComplete(); + + if ($response->operationSucceeded()) { + /** @var MetadataJob $result */ + $result = $response->getResult(); + printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString()); + } else { + /** @var Status $error */ + $error = $response->getError(); + printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString()); + } + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } +} + +/** + * Helper to execute the sample. + * + * This sample has been automatically generated and should be regarded as a code + * template only. It will require modifications to work: + * - It may require correct/in-range values for request initialization. + * - It may require specifying regional endpoints when creating the service client, + * please see the apiEndpoint client configuration option for more details. + */ +function callSample(): void +{ + $formattedParent = CatalogServiceClient::locationName('[PROJECT]', '[LOCATION]'); + $metadataJobType = Type::TYPE_UNSPECIFIED; + + create_metadata_job_sample($formattedParent, $metadataJobType); +} +// [END dataplex_v1_generated_CatalogService_CreateMetadataJob_sync] diff --git a/Dataplex/samples/V1/CatalogServiceClient/delete_aspect_type.php b/Dataplex/samples/V1/CatalogServiceClient/delete_aspect_type.php index 23789bc8760f..561eb52b1446 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/delete_aspect_type.php +++ b/Dataplex/samples/V1/CatalogServiceClient/delete_aspect_type.php @@ -30,7 +30,7 @@ use Google\Rpc\Status; /** - * Deletes a AspectType resource. + * Deletes an AspectType. * * @param string $formattedName The resource name of the AspectType: * `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`. Please see diff --git a/Dataplex/samples/V1/CatalogServiceClient/delete_entry_group.php b/Dataplex/samples/V1/CatalogServiceClient/delete_entry_group.php index 20f360eb34d7..3a4c675909bc 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/delete_entry_group.php +++ b/Dataplex/samples/V1/CatalogServiceClient/delete_entry_group.php @@ -30,7 +30,7 @@ use Google\Rpc\Status; /** - * Deletes a EntryGroup resource. + * Deletes an EntryGroup. * * @param string $formattedName The resource name of the EntryGroup: * `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`. Please see diff --git a/Dataplex/samples/V1/CatalogServiceClient/delete_entry_type.php b/Dataplex/samples/V1/CatalogServiceClient/delete_entry_type.php index 11d63b25acf5..cb547da45797 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/delete_entry_type.php +++ b/Dataplex/samples/V1/CatalogServiceClient/delete_entry_type.php @@ -30,7 +30,7 @@ use Google\Rpc\Status; /** - * Deletes a EntryType resource. + * Deletes an EntryType. * * @param string $formattedName The resource name of the EntryType: * `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`. Please see diff --git a/Dataplex/samples/V1/CatalogServiceClient/get_aspect_type.php b/Dataplex/samples/V1/CatalogServiceClient/get_aspect_type.php index ab19a09fca8d..80edaa6e8302 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/get_aspect_type.php +++ b/Dataplex/samples/V1/CatalogServiceClient/get_aspect_type.php @@ -29,7 +29,7 @@ use Google\Cloud\Dataplex\V1\GetAspectTypeRequest; /** - * Retrieves a AspectType resource. + * Gets an AspectType. * * @param string $formattedName The resource name of the AspectType: * `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`. Please see diff --git a/Dataplex/samples/V1/CatalogServiceClient/get_entry.php b/Dataplex/samples/V1/CatalogServiceClient/get_entry.php index 18eca4446f59..621e6d1a7907 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/get_entry.php +++ b/Dataplex/samples/V1/CatalogServiceClient/get_entry.php @@ -29,7 +29,12 @@ use Google\Cloud\Dataplex\V1\GetEntryRequest; /** - * Gets a single entry. + * Gets an Entry. + * + * **Caution**: The BigQuery metadata that is stored in Dataplex Catalog is + * changing. For more information, see [Changes to BigQuery metadata stored in + * Dataplex + * Catalog](https://cloud.google.com/dataplex/docs/biqquery-metadata-changes). * * @param string $formattedName The resource name of the Entry: * `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`. Please see diff --git a/Dataplex/samples/V1/CatalogServiceClient/get_entry_group.php b/Dataplex/samples/V1/CatalogServiceClient/get_entry_group.php index 3242cd4328c0..3b4ba65e05d0 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/get_entry_group.php +++ b/Dataplex/samples/V1/CatalogServiceClient/get_entry_group.php @@ -29,7 +29,7 @@ use Google\Cloud\Dataplex\V1\GetEntryGroupRequest; /** - * Retrieves a EntryGroup resource. + * Gets an EntryGroup. * * @param string $formattedName The resource name of the EntryGroup: * `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`. Please see diff --git a/Dataplex/samples/V1/CatalogServiceClient/get_entry_type.php b/Dataplex/samples/V1/CatalogServiceClient/get_entry_type.php index a6176b0d65b8..38b68583902a 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/get_entry_type.php +++ b/Dataplex/samples/V1/CatalogServiceClient/get_entry_type.php @@ -29,7 +29,7 @@ use Google\Cloud\Dataplex\V1\GetEntryTypeRequest; /** - * Retrieves a EntryType resource. + * Gets an EntryType. * * @param string $formattedName The resource name of the EntryType: * `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`. Please see diff --git a/Dataplex/samples/V1/CatalogServiceClient/get_metadata_job.php b/Dataplex/samples/V1/CatalogServiceClient/get_metadata_job.php new file mode 100644 index 000000000000..d5b3a3182dfb --- /dev/null +++ b/Dataplex/samples/V1/CatalogServiceClient/get_metadata_job.php @@ -0,0 +1,72 @@ +setName($formattedName); + + // Call the API and handle any network failures. + try { + /** @var MetadataJob $response */ + $response = $catalogServiceClient->getMetadataJob($request); + printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString()); + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } +} + +/** + * Helper to execute the sample. + * + * This sample has been automatically generated and should be regarded as a code + * template only. It will require modifications to work: + * - It may require correct/in-range values for request initialization. + * - It may require specifying regional endpoints when creating the service client, + * please see the apiEndpoint client configuration option for more details. + */ +function callSample(): void +{ + $formattedName = CatalogServiceClient::metadataJobName('[PROJECT]', '[LOCATION]', '[METADATAJOB]'); + + get_metadata_job_sample($formattedName); +} +// [END dataplex_v1_generated_CatalogService_GetMetadataJob_sync] diff --git a/Dataplex/samples/V1/CatalogServiceClient/list_aspect_types.php b/Dataplex/samples/V1/CatalogServiceClient/list_aspect_types.php index 7c5744ed0e28..056c414620d8 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/list_aspect_types.php +++ b/Dataplex/samples/V1/CatalogServiceClient/list_aspect_types.php @@ -34,7 +34,7 @@ * * @param string $formattedParent The resource name of the AspectType location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. Please see + * where `location_id` refers to a Google Cloud region. Please see * {@see CatalogServiceClient::locationName()} for help formatting this field. */ function list_aspect_types_sample(string $formattedParent): void diff --git a/Dataplex/samples/V1/CatalogServiceClient/list_entries.php b/Dataplex/samples/V1/CatalogServiceClient/list_entries.php index 7853c5b30725..3aaeb92b9619 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/list_entries.php +++ b/Dataplex/samples/V1/CatalogServiceClient/list_entries.php @@ -30,7 +30,7 @@ use Google\Cloud\Dataplex\V1\ListEntriesRequest; /** - * Lists entries within an entry group. + * Lists Entries within an EntryGroup. * * @param string $formattedParent The resource name of the parent Entry Group: * `projects/{project}/locations/{location}/entryGroups/{entry_group}`. Please see diff --git a/Dataplex/samples/V1/CatalogServiceClient/list_entry_groups.php b/Dataplex/samples/V1/CatalogServiceClient/list_entry_groups.php index faf00110727c..a045f899e7c5 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/list_entry_groups.php +++ b/Dataplex/samples/V1/CatalogServiceClient/list_entry_groups.php @@ -34,7 +34,7 @@ * * @param string $formattedParent The resource name of the entryGroup location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. Please see + * where `location_id` refers to a Google Cloud region. Please see * {@see CatalogServiceClient::locationName()} for help formatting this field. */ function list_entry_groups_sample(string $formattedParent): void diff --git a/Dataplex/samples/V1/CatalogServiceClient/list_entry_types.php b/Dataplex/samples/V1/CatalogServiceClient/list_entry_types.php index 2c0fdd652f62..70361fe7d31b 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/list_entry_types.php +++ b/Dataplex/samples/V1/CatalogServiceClient/list_entry_types.php @@ -34,7 +34,7 @@ * * @param string $formattedParent The resource name of the EntryType location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. Please see + * where `location_id` refers to a Google Cloud region. Please see * {@see CatalogServiceClient::locationName()} for help formatting this field. */ function list_entry_types_sample(string $formattedParent): void diff --git a/Dataplex/samples/V1/CatalogServiceClient/list_metadata_jobs.php b/Dataplex/samples/V1/CatalogServiceClient/list_metadata_jobs.php new file mode 100644 index 000000000000..4f0bc029fd7f --- /dev/null +++ b/Dataplex/samples/V1/CatalogServiceClient/list_metadata_jobs.php @@ -0,0 +1,77 @@ +setParent($formattedParent); + + // Call the API and handle any network failures. + try { + /** @var PagedListResponse $response */ + $response = $catalogServiceClient->listMetadataJobs($request); + + /** @var MetadataJob $element */ + foreach ($response as $element) { + printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString()); + } + } catch (ApiException $ex) { + printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage()); + } +} + +/** + * Helper to execute the sample. + * + * This sample has been automatically generated and should be regarded as a code + * template only. It will require modifications to work: + * - It may require correct/in-range values for request initialization. + * - It may require specifying regional endpoints when creating the service client, + * please see the apiEndpoint client configuration option for more details. + */ +function callSample(): void +{ + $formattedParent = CatalogServiceClient::locationName('[PROJECT]', '[LOCATION]'); + + list_metadata_jobs_sample($formattedParent); +} +// [END dataplex_v1_generated_CatalogService_ListMetadataJobs_sync] diff --git a/Dataplex/samples/V1/CatalogServiceClient/lookup_entry.php b/Dataplex/samples/V1/CatalogServiceClient/lookup_entry.php index 2cb2ccaf84db..1ee176ab526d 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/lookup_entry.php +++ b/Dataplex/samples/V1/CatalogServiceClient/lookup_entry.php @@ -29,7 +29,12 @@ use Google\Cloud\Dataplex\V1\LookupEntryRequest; /** - * Looks up a single entry. + * Looks up a single Entry by name using the permission on the source system. + * + * **Caution**: The BigQuery metadata that is stored in Dataplex Catalog is + * changing. For more information, see [Changes to BigQuery metadata stored in + * Dataplex + * Catalog](https://cloud.google.com/dataplex/docs/biqquery-metadata-changes). * * @param string $name The project to which the request should be attributed in the * following form: `projects/{project}/locations/{location}`. diff --git a/Dataplex/samples/V1/CatalogServiceClient/search_entries.php b/Dataplex/samples/V1/CatalogServiceClient/search_entries.php index f60465334282..277668d2fbb1 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/search_entries.php +++ b/Dataplex/samples/V1/CatalogServiceClient/search_entries.php @@ -30,20 +30,21 @@ use Google\Cloud\Dataplex\V1\SearchEntriesResult; /** - * Searches for entries matching given query and scope. + * Searches for Entries matching the given query and scope. * - * @param string $name The project to which the request should be attributed in the - * following form: `projects/{project}/locations/{location}`. - * @param string $query The query against which entries in scope should be matched. + * @param string $formattedName The project to which the request should be attributed in the + * following form: `projects/{project}/locations/{location}`. Please see + * {@see CatalogServiceClient::locationName()} for help formatting this field. + * @param string $query The query against which entries in scope should be matched. */ -function search_entries_sample(string $name, string $query): void +function search_entries_sample(string $formattedName, string $query): void { // Create a client. $catalogServiceClient = new CatalogServiceClient(); // Prepare the request message. $request = (new SearchEntriesRequest()) - ->setName($name) + ->setName($formattedName) ->setQuery($query); // Call the API and handle any network failures. @@ -71,9 +72,9 @@ function search_entries_sample(string $name, string $query): void */ function callSample(): void { - $name = '[NAME]'; + $formattedName = CatalogServiceClient::locationName('[PROJECT]', '[LOCATION]'); $query = '[QUERY]'; - search_entries_sample($name, $query); + search_entries_sample($formattedName, $query); } // [END dataplex_v1_generated_CatalogService_SearchEntries_sync] diff --git a/Dataplex/samples/V1/CatalogServiceClient/update_aspect_type.php b/Dataplex/samples/V1/CatalogServiceClient/update_aspect_type.php index d4a317be61b1..a9148361032e 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/update_aspect_type.php +++ b/Dataplex/samples/V1/CatalogServiceClient/update_aspect_type.php @@ -33,14 +33,26 @@ use Google\Rpc\Status; /** - * Updates a AspectType resource. + * Updates an AspectType. * * @param string $aspectTypeMetadataTemplateName The name of the field. * @param string $aspectTypeMetadataTemplateType The datatype of this field. The following values are supported: - * Primitive types (string, integer, boolean, double, datetime); datetime - * must be of the format RFC3339 UTC "Zulu" (Examples: - * "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex - * types (enum, array, map, record). + * + * Primitive types: + * + * * string + * * integer + * * boolean + * * double + * * datetime. Must be of the format RFC3339 UTC "Zulu" (Examples: + * "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). + * + * Complex types: + * + * * enum + * * array + * * map + * * record */ function update_aspect_type_sample( string $aspectTypeMetadataTemplateName, diff --git a/Dataplex/samples/V1/CatalogServiceClient/update_entry.php b/Dataplex/samples/V1/CatalogServiceClient/update_entry.php index f2eeb6146aa8..0c2051e29230 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/update_entry.php +++ b/Dataplex/samples/V1/CatalogServiceClient/update_entry.php @@ -31,8 +31,9 @@ /** * Updates an Entry. * - * @param string $entryEntryType Immutable. The resource name of the EntryType used to create this - * Entry. + * @param string $entryEntryType Immutable. The relative resource name of the entry type that was + * used to create this entry, in the format + * `projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}`. */ function update_entry_sample(string $entryEntryType): void { diff --git a/Dataplex/samples/V1/CatalogServiceClient/update_entry_group.php b/Dataplex/samples/V1/CatalogServiceClient/update_entry_group.php index 67f075f75ecc..c6559d791d8a 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/update_entry_group.php +++ b/Dataplex/samples/V1/CatalogServiceClient/update_entry_group.php @@ -32,7 +32,7 @@ use Google\Rpc\Status; /** - * Updates a EntryGroup resource. + * Updates an EntryGroup. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: diff --git a/Dataplex/samples/V1/CatalogServiceClient/update_entry_type.php b/Dataplex/samples/V1/CatalogServiceClient/update_entry_type.php index 571c132ab71d..594ab6e89f7d 100644 --- a/Dataplex/samples/V1/CatalogServiceClient/update_entry_type.php +++ b/Dataplex/samples/V1/CatalogServiceClient/update_entry_type.php @@ -32,7 +32,7 @@ use Google\Rpc\Status; /** - * Updates a EntryType resource. + * Updates an EntryType. * * This sample has been automatically generated and should be regarded as a code * template only. It will require modifications to work: diff --git a/Dataplex/src/V1/Aspect.php b/Dataplex/src/V1/Aspect.php index f4bf896cbff4..1118017b57b0 100644 --- a/Dataplex/src/V1/Aspect.php +++ b/Dataplex/src/V1/Aspect.php @@ -41,13 +41,14 @@ class Aspect extends \Google\Protobuf\Internal\Message protected $update_time = null; /** * Required. The content of the aspect, according to its aspect type schema. - * This will replace `content`. * The maximum size of the field is 120KB (encoded as UTF-8). * * Generated from protobuf field .google.protobuf.Struct data = 8 [(.google.api.field_behavior) = REQUIRED]; */ protected $data = null; /** + * Optional. Information related to the source system of the aspect. + * * Generated from protobuf field .google.cloud.dataplex.v1.AspectSource aspect_source = 9 [(.google.api.field_behavior) = OPTIONAL]; */ protected $aspect_source = null; @@ -68,9 +69,9 @@ class Aspect extends \Google\Protobuf\Internal\Message * Output only. The time when the Aspect was last updated. * @type \Google\Protobuf\Struct $data * Required. The content of the aspect, according to its aspect type schema. - * This will replace `content`. * The maximum size of the field is 120KB (encoded as UTF-8). * @type \Google\Cloud\Dataplex\V1\AspectSource $aspect_source + * Optional. Information related to the source system of the aspect. * } */ public function __construct($data = NULL) { @@ -204,7 +205,6 @@ public function setUpdateTime($var) /** * Required. The content of the aspect, according to its aspect type schema. - * This will replace `content`. * The maximum size of the field is 120KB (encoded as UTF-8). * * Generated from protobuf field .google.protobuf.Struct data = 8 [(.google.api.field_behavior) = REQUIRED]; @@ -227,7 +227,6 @@ public function clearData() /** * Required. The content of the aspect, according to its aspect type schema. - * This will replace `content`. * The maximum size of the field is 120KB (encoded as UTF-8). * * Generated from protobuf field .google.protobuf.Struct data = 8 [(.google.api.field_behavior) = REQUIRED]; @@ -243,6 +242,8 @@ public function setData($var) } /** + * Optional. Information related to the source system of the aspect. + * * Generated from protobuf field .google.cloud.dataplex.v1.AspectSource aspect_source = 9 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\Dataplex\V1\AspectSource|null */ @@ -262,6 +263,8 @@ public function clearAspectSource() } /** + * Optional. Information related to the source system of the aspect. + * * Generated from protobuf field .google.cloud.dataplex.v1.AspectSource aspect_source = 9 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\Dataplex\V1\AspectSource $var * @return $this diff --git a/Dataplex/src/V1/AspectSource.php b/Dataplex/src/V1/AspectSource.php index 65fc88f959c5..a0c3aeb9bb1e 100644 --- a/Dataplex/src/V1/AspectSource.php +++ b/Dataplex/src/V1/AspectSource.php @@ -9,25 +9,32 @@ use Google\Protobuf\Internal\GPBUtil; /** - * AspectSource contains source system related information for the - * aspect. + * Information related to the source system of the aspect. * * Generated from protobuf message google.cloud.dataplex.v1.AspectSource */ class AspectSource extends \Google\Protobuf\Internal\Message { /** - * The create time of the aspect in the source system. + * The time the aspect was created in the source system. * * Generated from protobuf field .google.protobuf.Timestamp create_time = 10; */ protected $create_time = null; /** - * The update time of the aspect in the source system. + * The time the aspect was last updated in the source system. * * Generated from protobuf field .google.protobuf.Timestamp update_time = 11; */ protected $update_time = null; + /** + * The version of the data format used to produce this data. This field is + * used to indicated when the underlying data format changes (e.g., schema + * modifications, changes to the source URL format definition, etc). + * + * Generated from protobuf field string data_version = 12; + */ + protected $data_version = ''; /** * Constructor. @@ -36,9 +43,13 @@ class AspectSource extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type \Google\Protobuf\Timestamp $create_time - * The create time of the aspect in the source system. + * The time the aspect was created in the source system. * @type \Google\Protobuf\Timestamp $update_time - * The update time of the aspect in the source system. + * The time the aspect was last updated in the source system. + * @type string $data_version + * The version of the data format used to produce this data. This field is + * used to indicated when the underlying data format changes (e.g., schema + * modifications, changes to the source URL format definition, etc). * } */ public function __construct($data = NULL) { @@ -47,7 +58,7 @@ public function __construct($data = NULL) { } /** - * The create time of the aspect in the source system. + * The time the aspect was created in the source system. * * Generated from protobuf field .google.protobuf.Timestamp create_time = 10; * @return \Google\Protobuf\Timestamp|null @@ -68,7 +79,7 @@ public function clearCreateTime() } /** - * The create time of the aspect in the source system. + * The time the aspect was created in the source system. * * Generated from protobuf field .google.protobuf.Timestamp create_time = 10; * @param \Google\Protobuf\Timestamp $var @@ -83,7 +94,7 @@ public function setCreateTime($var) } /** - * The update time of the aspect in the source system. + * The time the aspect was last updated in the source system. * * Generated from protobuf field .google.protobuf.Timestamp update_time = 11; * @return \Google\Protobuf\Timestamp|null @@ -104,7 +115,7 @@ public function clearUpdateTime() } /** - * The update time of the aspect in the source system. + * The time the aspect was last updated in the source system. * * Generated from protobuf field .google.protobuf.Timestamp update_time = 11; * @param \Google\Protobuf\Timestamp $var @@ -118,5 +129,35 @@ public function setUpdateTime($var) return $this; } + /** + * The version of the data format used to produce this data. This field is + * used to indicated when the underlying data format changes (e.g., schema + * modifications, changes to the source URL format definition, etc). + * + * Generated from protobuf field string data_version = 12; + * @return string + */ + public function getDataVersion() + { + return $this->data_version; + } + + /** + * The version of the data format used to produce this data. This field is + * used to indicated when the underlying data format changes (e.g., schema + * modifications, changes to the source URL format definition, etc). + * + * Generated from protobuf field string data_version = 12; + * @param string $var + * @return $this + */ + public function setDataVersion($var) + { + GPBUtil::checkString($var, True); + $this->data_version = $var; + + return $this; + } + } diff --git a/Dataplex/src/V1/AspectType.php b/Dataplex/src/V1/AspectType.php index 40dd2a9326b1..55c0da4b7149 100644 --- a/Dataplex/src/V1/AspectType.php +++ b/Dataplex/src/V1/AspectType.php @@ -9,8 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Aspect Type is a template for creating Aspects, and represents the - * JSON-schema for a given Entry, e.g., BigQuery Table Schema. + * AspectType is a template for creating Aspects, and represents the + * JSON-schema for a given Entry, for example, BigQuery Table Schema. * * Generated from protobuf message google.cloud.dataplex.v1.AspectType */ @@ -24,9 +24,9 @@ class AspectType extends \Google\Protobuf\Internal\Message */ protected $name = ''; /** - * Output only. System generated globally unique ID for the AspectType. This - * ID will be different if the AspectType is deleted and re-created with the - * same name. + * Output only. System generated globally unique ID for the AspectType. + * If you delete and recreate the AspectType with the same name, then this ID + * will be different. * * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -62,15 +62,14 @@ class AspectType extends \Google\Protobuf\Internal\Message */ private $labels; /** - * This checksum is computed by the server based on the value of other - * fields, and may be sent on update and delete requests to ensure the - * client has an up-to-date value before proceeding. + * The service computes this checksum. The client may send it on update and + * delete requests to ensure it has an up-to-date value before proceeding. * * Generated from protobuf field string etag = 8; */ protected $etag = ''; /** - * Immutable. Authorization defined for this type. + * Immutable. Defines the Authorization for this type. * * Generated from protobuf field .google.cloud.dataplex.v1.AspectType.Authorization authorization = 52 [(.google.api.field_behavior) = IMMUTABLE]; */ @@ -99,9 +98,9 @@ class AspectType extends \Google\Protobuf\Internal\Message * Output only. The relative resource name of the AspectType, of the form: * projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}. * @type string $uid - * Output only. System generated globally unique ID for the AspectType. This - * ID will be different if the AspectType is deleted and re-created with the - * same name. + * Output only. System generated globally unique ID for the AspectType. + * If you delete and recreate the AspectType with the same name, then this ID + * will be different. * @type \Google\Protobuf\Timestamp $create_time * Output only. The time when the AspectType was created. * @type \Google\Protobuf\Timestamp $update_time @@ -113,11 +112,10 @@ class AspectType extends \Google\Protobuf\Internal\Message * @type array|\Google\Protobuf\Internal\MapField $labels * Optional. User-defined labels for the AspectType. * @type string $etag - * This checksum is computed by the server based on the value of other - * fields, and may be sent on update and delete requests to ensure the - * client has an up-to-date value before proceeding. + * The service computes this checksum. The client may send it on update and + * delete requests to ensure it has an up-to-date value before proceeding. * @type \Google\Cloud\Dataplex\V1\AspectType\Authorization $authorization - * Immutable. Authorization defined for this type. + * Immutable. Defines the Authorization for this type. * @type \Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate $metadata_template * Required. MetadataTemplate of the aspect. * @type int $transfer_status @@ -159,9 +157,9 @@ public function setName($var) } /** - * Output only. System generated globally unique ID for the AspectType. This - * ID will be different if the AspectType is deleted and re-created with the - * same name. + * Output only. System generated globally unique ID for the AspectType. + * If you delete and recreate the AspectType with the same name, then this ID + * will be different. * * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string @@ -172,9 +170,9 @@ public function getUid() } /** - * Output only. System generated globally unique ID for the AspectType. This - * ID will be different if the AspectType is deleted and re-created with the - * same name. + * Output only. System generated globally unique ID for the AspectType. + * If you delete and recreate the AspectType with the same name, then this ID + * will be different. * * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var @@ -339,9 +337,8 @@ public function setLabels($var) } /** - * This checksum is computed by the server based on the value of other - * fields, and may be sent on update and delete requests to ensure the - * client has an up-to-date value before proceeding. + * The service computes this checksum. The client may send it on update and + * delete requests to ensure it has an up-to-date value before proceeding. * * Generated from protobuf field string etag = 8; * @return string @@ -352,9 +349,8 @@ public function getEtag() } /** - * This checksum is computed by the server based on the value of other - * fields, and may be sent on update and delete requests to ensure the - * client has an up-to-date value before proceeding. + * The service computes this checksum. The client may send it on update and + * delete requests to ensure it has an up-to-date value before proceeding. * * Generated from protobuf field string etag = 8; * @param string $var @@ -369,7 +365,7 @@ public function setEtag($var) } /** - * Immutable. Authorization defined for this type. + * Immutable. Defines the Authorization for this type. * * Generated from protobuf field .google.cloud.dataplex.v1.AspectType.Authorization authorization = 52 [(.google.api.field_behavior) = IMMUTABLE]; * @return \Google\Cloud\Dataplex\V1\AspectType\Authorization|null @@ -390,7 +386,7 @@ public function clearAuthorization() } /** - * Immutable. Authorization defined for this type. + * Immutable. Defines the Authorization for this type. * * Generated from protobuf field .google.cloud.dataplex.v1.AspectType.Authorization authorization = 52 [(.google.api.field_behavior) = IMMUTABLE]; * @param \Google\Cloud\Dataplex\V1\AspectType\Authorization $var diff --git a/Dataplex/src/V1/AspectType/Authorization.php b/Dataplex/src/V1/AspectType/Authorization.php index ee7f50c39035..73a9011697e4 100644 --- a/Dataplex/src/V1/AspectType/Authorization.php +++ b/Dataplex/src/V1/AspectType/Authorization.php @@ -9,16 +9,16 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Autorization for an Aspect Type. + * Autorization for an AspectType. * * Generated from protobuf message google.cloud.dataplex.v1.AspectType.Authorization */ class Authorization extends \Google\Protobuf\Internal\Message { /** - * Immutable. The IAM permission grantable on the Entry Group to allow - * access to instantiate Aspects of Dataplex owned Aspect Types, only - * settable for Dataplex owned Types. + * Immutable. The IAM permission grantable on the EntryGroup to allow access + * to instantiate Aspects of Dataplex owned AspectTypes, only settable for + * Dataplex owned Types. * * Generated from protobuf field string alternate_use_permission = 1 [(.google.api.field_behavior) = IMMUTABLE]; */ @@ -31,9 +31,9 @@ class Authorization extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $alternate_use_permission - * Immutable. The IAM permission grantable on the Entry Group to allow - * access to instantiate Aspects of Dataplex owned Aspect Types, only - * settable for Dataplex owned Types. + * Immutable. The IAM permission grantable on the EntryGroup to allow access + * to instantiate Aspects of Dataplex owned AspectTypes, only settable for + * Dataplex owned Types. * } */ public function __construct($data = NULL) { @@ -42,9 +42,9 @@ public function __construct($data = NULL) { } /** - * Immutable. The IAM permission grantable on the Entry Group to allow - * access to instantiate Aspects of Dataplex owned Aspect Types, only - * settable for Dataplex owned Types. + * Immutable. The IAM permission grantable on the EntryGroup to allow access + * to instantiate Aspects of Dataplex owned AspectTypes, only settable for + * Dataplex owned Types. * * Generated from protobuf field string alternate_use_permission = 1 [(.google.api.field_behavior) = IMMUTABLE]; * @return string @@ -55,9 +55,9 @@ public function getAlternateUsePermission() } /** - * Immutable. The IAM permission grantable on the Entry Group to allow - * access to instantiate Aspects of Dataplex owned Aspect Types, only - * settable for Dataplex owned Types. + * Immutable. The IAM permission grantable on the EntryGroup to allow access + * to instantiate Aspects of Dataplex owned AspectTypes, only settable for + * Dataplex owned Types. * * Generated from protobuf field string alternate_use_permission = 1 [(.google.api.field_behavior) = IMMUTABLE]; * @param string $var diff --git a/Dataplex/src/V1/AspectType/MetadataTemplate.php b/Dataplex/src/V1/AspectType/MetadataTemplate.php index e631c9330608..5ebb7242bcc3 100644 --- a/Dataplex/src/V1/AspectType/MetadataTemplate.php +++ b/Dataplex/src/V1/AspectType/MetadataTemplate.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * MetadataTemplate definition for AspectType + * MetadataTemplate definition for an AspectType. * * Generated from protobuf message google.cloud.dataplex.v1.AspectType.MetadataTemplate */ @@ -34,60 +34,68 @@ class MetadataTemplate extends \Google\Protobuf\Internal\Message protected $name = ''; /** * Required. The datatype of this field. The following values are supported: - * Primitive types (string, integer, boolean, double, datetime); datetime - * must be of the format RFC3339 UTC "Zulu" (Examples: - * "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex - * types (enum, array, map, record). + * Primitive types: + * * string + * * integer + * * boolean + * * double + * * datetime. Must be of the format RFC3339 UTC "Zulu" (Examples: + * "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). + * Complex types: + * * enum + * * array + * * map + * * record * * Generated from protobuf field string type = 5 [(.google.api.field_behavior) = REQUIRED]; */ protected $type = ''; /** - * Optional. Field definition, needs to be specified if the type is record. - * Defines the nested fields. + * Optional. Field definition. You must specify it if the type is record. It + * defines the nested fields. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate record_fields = 6 [(.google.api.field_behavior) = OPTIONAL]; */ private $record_fields; /** - * Optional. The list of values for an enum type. Needs to be defined if the + * Optional. The list of values for an enum type. You must define it if the * type is enum. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate.EnumValue enum_values = 8 [(.google.api.field_behavior) = OPTIONAL]; */ private $enum_values; /** - * Optional. map_items needs to be set if the type is map. map_items can - * refer to a primitive field or a complex (record only) field. To specify a - * primitive field, just name and type needs to be set in the nested + * Optional. If the type is map, set map_items. map_items can refer to a + * primitive field or a complex (record only) field. To specify a primitive + * field, you only need to set name and type in the nested * MetadataTemplate. The recommended value for the name field is item, as - * this is not used in the actual payload. + * this isn't used in the actual payload. * * Generated from protobuf field .google.cloud.dataplex.v1.AspectType.MetadataTemplate map_items = 10 [(.google.api.field_behavior) = OPTIONAL]; */ protected $map_items = null; /** - * Optional. array_items needs to be set if the type is array. array_items - * can refer to a primitive field or a complex (record only) field. To - * specify a primitive field, just name and type needs to be set in the - * nested MetadataTemplate. The recommended value for the name field is - * item, as this is not used in the actual payload. + * Optional. If the type is array, set array_items. array_items can refer + * to a primitive field or a complex (record only) field. To specify a + * primitive field, you only need to set name and type in the nested + * MetadataTemplate. The recommended value for the name field is item, as + * this isn't used in the actual payload. * * Generated from protobuf field .google.cloud.dataplex.v1.AspectType.MetadataTemplate array_items = 11 [(.google.api.field_behavior) = OPTIONAL]; */ protected $array_items = null; /** - * Optional. Id can be used if this definition of the field needs to be - * reused later. Id needs to be unique across the entire template. Id can - * only be specified if the field type is record. + * Optional. You can use type id if this definition of the field needs to be + * reused later. The type id must be unique across the entire template. You + * can only specify it if the field type is record. * * Generated from protobuf field string type_id = 12 [(.google.api.field_behavior) = OPTIONAL]; */ protected $type_id = ''; /** - * Optional. A reference to another field definition (instead of an inline + * Optional. A reference to another field definition (not an inline * definition). The value must be equal to the value of an id field defined - * elsewhere in the MetadataTemplate. Only fields with type as record can + * elsewhere in the MetadataTemplate. Only fields with record type can * refer to other fields. * * Generated from protobuf field string type_ref = 13 [(.google.api.field_behavior) = OPTIONAL]; @@ -123,36 +131,44 @@ class MetadataTemplate extends \Google\Protobuf\Internal\Message * Required. The name of the field. * @type string $type * Required. The datatype of this field. The following values are supported: - * Primitive types (string, integer, boolean, double, datetime); datetime - * must be of the format RFC3339 UTC "Zulu" (Examples: - * "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex - * types (enum, array, map, record). + * Primitive types: + * * string + * * integer + * * boolean + * * double + * * datetime. Must be of the format RFC3339 UTC "Zulu" (Examples: + * "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). + * Complex types: + * * enum + * * array + * * map + * * record * @type array<\Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate>|\Google\Protobuf\Internal\RepeatedField $record_fields - * Optional. Field definition, needs to be specified if the type is record. - * Defines the nested fields. + * Optional. Field definition. You must specify it if the type is record. It + * defines the nested fields. * @type array<\Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate\EnumValue>|\Google\Protobuf\Internal\RepeatedField $enum_values - * Optional. The list of values for an enum type. Needs to be defined if the + * Optional. The list of values for an enum type. You must define it if the * type is enum. * @type \Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate $map_items - * Optional. map_items needs to be set if the type is map. map_items can - * refer to a primitive field or a complex (record only) field. To specify a - * primitive field, just name and type needs to be set in the nested + * Optional. If the type is map, set map_items. map_items can refer to a + * primitive field or a complex (record only) field. To specify a primitive + * field, you only need to set name and type in the nested * MetadataTemplate. The recommended value for the name field is item, as - * this is not used in the actual payload. + * this isn't used in the actual payload. * @type \Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate $array_items - * Optional. array_items needs to be set if the type is array. array_items - * can refer to a primitive field or a complex (record only) field. To - * specify a primitive field, just name and type needs to be set in the - * nested MetadataTemplate. The recommended value for the name field is - * item, as this is not used in the actual payload. + * Optional. If the type is array, set array_items. array_items can refer + * to a primitive field or a complex (record only) field. To specify a + * primitive field, you only need to set name and type in the nested + * MetadataTemplate. The recommended value for the name field is item, as + * this isn't used in the actual payload. * @type string $type_id - * Optional. Id can be used if this definition of the field needs to be - * reused later. Id needs to be unique across the entire template. Id can - * only be specified if the field type is record. + * Optional. You can use type id if this definition of the field needs to be + * reused later. The type id must be unique across the entire template. You + * can only specify it if the field type is record. * @type string $type_ref - * Optional. A reference to another field definition (instead of an inline + * Optional. A reference to another field definition (not an inline * definition). The value must be equal to the value of an id field defined - * elsewhere in the MetadataTemplate. Only fields with type as record can + * elsewhere in the MetadataTemplate. Only fields with record type can * refer to other fields. * @type \Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate\Constraints $constraints * Optional. Specifies the constraints on this field. @@ -229,10 +245,18 @@ public function setName($var) /** * Required. The datatype of this field. The following values are supported: - * Primitive types (string, integer, boolean, double, datetime); datetime - * must be of the format RFC3339 UTC "Zulu" (Examples: - * "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex - * types (enum, array, map, record). + * Primitive types: + * * string + * * integer + * * boolean + * * double + * * datetime. Must be of the format RFC3339 UTC "Zulu" (Examples: + * "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). + * Complex types: + * * enum + * * array + * * map + * * record * * Generated from protobuf field string type = 5 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -244,10 +268,18 @@ public function getType() /** * Required. The datatype of this field. The following values are supported: - * Primitive types (string, integer, boolean, double, datetime); datetime - * must be of the format RFC3339 UTC "Zulu" (Examples: - * "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex - * types (enum, array, map, record). + * Primitive types: + * * string + * * integer + * * boolean + * * double + * * datetime. Must be of the format RFC3339 UTC "Zulu" (Examples: + * "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). + * Complex types: + * * enum + * * array + * * map + * * record * * Generated from protobuf field string type = 5 [(.google.api.field_behavior) = REQUIRED]; * @param string $var @@ -262,8 +294,8 @@ public function setType($var) } /** - * Optional. Field definition, needs to be specified if the type is record. - * Defines the nested fields. + * Optional. Field definition. You must specify it if the type is record. It + * defines the nested fields. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate record_fields = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField @@ -274,8 +306,8 @@ public function getRecordFields() } /** - * Optional. Field definition, needs to be specified if the type is record. - * Defines the nested fields. + * Optional. Field definition. You must specify it if the type is record. It + * defines the nested fields. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate record_fields = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param array<\Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate>|\Google\Protobuf\Internal\RepeatedField $var @@ -290,7 +322,7 @@ public function setRecordFields($var) } /** - * Optional. The list of values for an enum type. Needs to be defined if the + * Optional. The list of values for an enum type. You must define it if the * type is enum. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate.EnumValue enum_values = 8 [(.google.api.field_behavior) = OPTIONAL]; @@ -302,7 +334,7 @@ public function getEnumValues() } /** - * Optional. The list of values for an enum type. Needs to be defined if the + * Optional. The list of values for an enum type. You must define it if the * type is enum. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.AspectType.MetadataTemplate.EnumValue enum_values = 8 [(.google.api.field_behavior) = OPTIONAL]; @@ -318,11 +350,11 @@ public function setEnumValues($var) } /** - * Optional. map_items needs to be set if the type is map. map_items can - * refer to a primitive field or a complex (record only) field. To specify a - * primitive field, just name and type needs to be set in the nested + * Optional. If the type is map, set map_items. map_items can refer to a + * primitive field or a complex (record only) field. To specify a primitive + * field, you only need to set name and type in the nested * MetadataTemplate. The recommended value for the name field is item, as - * this is not used in the actual payload. + * this isn't used in the actual payload. * * Generated from protobuf field .google.cloud.dataplex.v1.AspectType.MetadataTemplate map_items = 10 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate|null @@ -343,11 +375,11 @@ public function clearMapItems() } /** - * Optional. map_items needs to be set if the type is map. map_items can - * refer to a primitive field or a complex (record only) field. To specify a - * primitive field, just name and type needs to be set in the nested + * Optional. If the type is map, set map_items. map_items can refer to a + * primitive field or a complex (record only) field. To specify a primitive + * field, you only need to set name and type in the nested * MetadataTemplate. The recommended value for the name field is item, as - * this is not used in the actual payload. + * this isn't used in the actual payload. * * Generated from protobuf field .google.cloud.dataplex.v1.AspectType.MetadataTemplate map_items = 10 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate $var @@ -362,11 +394,11 @@ public function setMapItems($var) } /** - * Optional. array_items needs to be set if the type is array. array_items - * can refer to a primitive field or a complex (record only) field. To - * specify a primitive field, just name and type needs to be set in the - * nested MetadataTemplate. The recommended value for the name field is - * item, as this is not used in the actual payload. + * Optional. If the type is array, set array_items. array_items can refer + * to a primitive field or a complex (record only) field. To specify a + * primitive field, you only need to set name and type in the nested + * MetadataTemplate. The recommended value for the name field is item, as + * this isn't used in the actual payload. * * Generated from protobuf field .google.cloud.dataplex.v1.AspectType.MetadataTemplate array_items = 11 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate|null @@ -387,11 +419,11 @@ public function clearArrayItems() } /** - * Optional. array_items needs to be set if the type is array. array_items - * can refer to a primitive field or a complex (record only) field. To - * specify a primitive field, just name and type needs to be set in the - * nested MetadataTemplate. The recommended value for the name field is - * item, as this is not used in the actual payload. + * Optional. If the type is array, set array_items. array_items can refer + * to a primitive field or a complex (record only) field. To specify a + * primitive field, you only need to set name and type in the nested + * MetadataTemplate. The recommended value for the name field is item, as + * this isn't used in the actual payload. * * Generated from protobuf field .google.cloud.dataplex.v1.AspectType.MetadataTemplate array_items = 11 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate $var @@ -406,9 +438,9 @@ public function setArrayItems($var) } /** - * Optional. Id can be used if this definition of the field needs to be - * reused later. Id needs to be unique across the entire template. Id can - * only be specified if the field type is record. + * Optional. You can use type id if this definition of the field needs to be + * reused later. The type id must be unique across the entire template. You + * can only specify it if the field type is record. * * Generated from protobuf field string type_id = 12 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -419,9 +451,9 @@ public function getTypeId() } /** - * Optional. Id can be used if this definition of the field needs to be - * reused later. Id needs to be unique across the entire template. Id can - * only be specified if the field type is record. + * Optional. You can use type id if this definition of the field needs to be + * reused later. The type id must be unique across the entire template. You + * can only specify it if the field type is record. * * Generated from protobuf field string type_id = 12 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -436,9 +468,9 @@ public function setTypeId($var) } /** - * Optional. A reference to another field definition (instead of an inline + * Optional. A reference to another field definition (not an inline * definition). The value must be equal to the value of an id field defined - * elsewhere in the MetadataTemplate. Only fields with type as record can + * elsewhere in the MetadataTemplate. Only fields with record type can * refer to other fields. * * Generated from protobuf field string type_ref = 13 [(.google.api.field_behavior) = OPTIONAL]; @@ -450,9 +482,9 @@ public function getTypeRef() } /** - * Optional. A reference to another field definition (instead of an inline + * Optional. A reference to another field definition (not an inline * definition). The value must be equal to the value of an id field defined - * elsewhere in the MetadataTemplate. Only fields with type as record can + * elsewhere in the MetadataTemplate. Only fields with record type can * refer to other fields. * * Generated from protobuf field string type_ref = 13 [(.google.api.field_behavior) = OPTIONAL]; diff --git a/Dataplex/src/V1/AspectType/MetadataTemplate/Annotations.php b/Dataplex/src/V1/AspectType/MetadataTemplate/Annotations.php index e63de64648ae..0b97f02b3e34 100644 --- a/Dataplex/src/V1/AspectType/MetadataTemplate/Annotations.php +++ b/Dataplex/src/V1/AspectType/MetadataTemplate/Annotations.php @@ -9,50 +9,51 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Definition of the annotations of a field + * Definition of the annotations of a field. * * Generated from protobuf message google.cloud.dataplex.v1.AspectType.MetadataTemplate.Annotations */ class Annotations extends \Google\Protobuf\Internal\Message { /** - * Optional. Marks a field as deprecated, a deprecation message can be - * included. + * Optional. Marks a field as deprecated. You can include a deprecation + * message. * * Generated from protobuf field string deprecated = 1 [(.google.api.field_behavior) = OPTIONAL]; */ protected $deprecated = ''; /** - * Optional. Specify a displayname for a field. + * Optional. Display name for a field. * * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $display_name = ''; /** - * Optional. Specify a description for a field + * Optional. Description for a field. * * Generated from protobuf field string description = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $description = ''; /** - * Optional. Specify a display order for a field. Display order can be - * used to reorder where a field is rendered + * Optional. Display order for a field. You can use this to reorder where + * a field is rendered. * * Generated from protobuf field int32 display_order = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $display_order = 0; /** - * Optional. String Type annotations can be used to specify special - * meaning to string fields. The following values are supported: richText: - * The field must be interpreted as a rich text field. url: A fully - * qualified url link. resource: A service qualified resource reference. + * Optional. You can use String Type annotations to specify special + * meaning to string fields. The following values are supported: + * * richText: The field must be interpreted as a rich text field. + * * url: A fully qualified URL link. + * * resource: A service qualified resource reference. * * Generated from protobuf field string string_type = 6 [(.google.api.field_behavior) = OPTIONAL]; */ protected $string_type = ''; /** - * Optional. Suggested hints for string fields. These can be used to - * suggest values to users, through an UI for example. + * Optional. Suggested hints for string fields. You can use them to + * suggest values to users through console. * * Generated from protobuf field repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -65,23 +66,24 @@ class Annotations extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $deprecated - * Optional. Marks a field as deprecated, a deprecation message can be - * included. + * Optional. Marks a field as deprecated. You can include a deprecation + * message. * @type string $display_name - * Optional. Specify a displayname for a field. + * Optional. Display name for a field. * @type string $description - * Optional. Specify a description for a field + * Optional. Description for a field. * @type int $display_order - * Optional. Specify a display order for a field. Display order can be - * used to reorder where a field is rendered + * Optional. Display order for a field. You can use this to reorder where + * a field is rendered. * @type string $string_type - * Optional. String Type annotations can be used to specify special - * meaning to string fields. The following values are supported: richText: - * The field must be interpreted as a rich text field. url: A fully - * qualified url link. resource: A service qualified resource reference. + * Optional. You can use String Type annotations to specify special + * meaning to string fields. The following values are supported: + * * richText: The field must be interpreted as a rich text field. + * * url: A fully qualified URL link. + * * resource: A service qualified resource reference. * @type array|\Google\Protobuf\Internal\RepeatedField $string_values - * Optional. Suggested hints for string fields. These can be used to - * suggest values to users, through an UI for example. + * Optional. Suggested hints for string fields. You can use them to + * suggest values to users through console. * } */ public function __construct($data = NULL) { @@ -90,8 +92,8 @@ public function __construct($data = NULL) { } /** - * Optional. Marks a field as deprecated, a deprecation message can be - * included. + * Optional. Marks a field as deprecated. You can include a deprecation + * message. * * Generated from protobuf field string deprecated = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -102,8 +104,8 @@ public function getDeprecated() } /** - * Optional. Marks a field as deprecated, a deprecation message can be - * included. + * Optional. Marks a field as deprecated. You can include a deprecation + * message. * * Generated from protobuf field string deprecated = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -118,7 +120,7 @@ public function setDeprecated($var) } /** - * Optional. Specify a displayname for a field. + * Optional. Display name for a field. * * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -129,7 +131,7 @@ public function getDisplayName() } /** - * Optional. Specify a displayname for a field. + * Optional. Display name for a field. * * Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -144,7 +146,7 @@ public function setDisplayName($var) } /** - * Optional. Specify a description for a field + * Optional. Description for a field. * * Generated from protobuf field string description = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -155,7 +157,7 @@ public function getDescription() } /** - * Optional. Specify a description for a field + * Optional. Description for a field. * * Generated from protobuf field string description = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -170,8 +172,8 @@ public function setDescription($var) } /** - * Optional. Specify a display order for a field. Display order can be - * used to reorder where a field is rendered + * Optional. Display order for a field. You can use this to reorder where + * a field is rendered. * * Generated from protobuf field int32 display_order = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -182,8 +184,8 @@ public function getDisplayOrder() } /** - * Optional. Specify a display order for a field. Display order can be - * used to reorder where a field is rendered + * Optional. Display order for a field. You can use this to reorder where + * a field is rendered. * * Generated from protobuf field int32 display_order = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var @@ -198,10 +200,11 @@ public function setDisplayOrder($var) } /** - * Optional. String Type annotations can be used to specify special - * meaning to string fields. The following values are supported: richText: - * The field must be interpreted as a rich text field. url: A fully - * qualified url link. resource: A service qualified resource reference. + * Optional. You can use String Type annotations to specify special + * meaning to string fields. The following values are supported: + * * richText: The field must be interpreted as a rich text field. + * * url: A fully qualified URL link. + * * resource: A service qualified resource reference. * * Generated from protobuf field string string_type = 6 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -212,10 +215,11 @@ public function getStringType() } /** - * Optional. String Type annotations can be used to specify special - * meaning to string fields. The following values are supported: richText: - * The field must be interpreted as a rich text field. url: A fully - * qualified url link. resource: A service qualified resource reference. + * Optional. You can use String Type annotations to specify special + * meaning to string fields. The following values are supported: + * * richText: The field must be interpreted as a rich text field. + * * url: A fully qualified URL link. + * * resource: A service qualified resource reference. * * Generated from protobuf field string string_type = 6 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -230,8 +234,8 @@ public function setStringType($var) } /** - * Optional. Suggested hints for string fields. These can be used to - * suggest values to users, through an UI for example. + * Optional. Suggested hints for string fields. You can use them to + * suggest values to users through console. * * Generated from protobuf field repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField @@ -242,8 +246,8 @@ public function getStringValues() } /** - * Optional. Suggested hints for string fields. These can be used to - * suggest values to users, through an UI for example. + * Optional. Suggested hints for string fields. You can use them to + * suggest values to users through console. * * Generated from protobuf field repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Dataplex/src/V1/AspectType/MetadataTemplate/Constraints.php b/Dataplex/src/V1/AspectType/MetadataTemplate/Constraints.php index 1af617b6bd14..233706888346 100644 --- a/Dataplex/src/V1/AspectType/MetadataTemplate/Constraints.php +++ b/Dataplex/src/V1/AspectType/MetadataTemplate/Constraints.php @@ -9,14 +9,14 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Definition of the constraints of a field + * Definition of the constraints of a field. * * Generated from protobuf message google.cloud.dataplex.v1.AspectType.MetadataTemplate.Constraints */ class Constraints extends \Google\Protobuf\Internal\Message { /** - * Optional. Marks this as an optional/required field. + * Optional. Marks this field as optional or required. * * Generated from protobuf field bool required = 1 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -29,7 +29,7 @@ class Constraints extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type bool $required - * Optional. Marks this as an optional/required field. + * Optional. Marks this field as optional or required. * } */ public function __construct($data = NULL) { @@ -38,7 +38,7 @@ public function __construct($data = NULL) { } /** - * Optional. Marks this as an optional/required field. + * Optional. Marks this field as optional or required. * * Generated from protobuf field bool required = 1 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -49,7 +49,7 @@ public function getRequired() } /** - * Optional. Marks this as an optional/required field. + * Optional. Marks this field as optional or required. * * Generated from protobuf field bool required = 1 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/Dataplex/src/V1/AspectType/MetadataTemplate/EnumValue.php b/Dataplex/src/V1/AspectType/MetadataTemplate/EnumValue.php index 619144388291..c3f94b6a5051 100644 --- a/Dataplex/src/V1/AspectType/MetadataTemplate/EnumValue.php +++ b/Dataplex/src/V1/AspectType/MetadataTemplate/EnumValue.php @@ -9,28 +9,28 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Definition of Enumvalue (to be used by enum fields) + * Definition of Enumvalue, to be used for enum fields. * * Generated from protobuf message google.cloud.dataplex.v1.AspectType.MetadataTemplate.EnumValue */ class EnumValue extends \Google\Protobuf\Internal\Message { /** - * Required. Index for the enum. Cannot be modified. + * Required. Index for the enum value. It can't be modified. * * Generated from protobuf field int32 index = 1 [(.google.api.field_behavior) = REQUIRED]; */ protected $index = 0; /** * Required. Name of the enumvalue. This is the actual value that the - * aspect will contain. + * aspect can contain. * * Generated from protobuf field string name = 2 [(.google.api.field_behavior) = REQUIRED]; */ protected $name = ''; /** - * Optional. Optional deprecation message to be set if an enum value needs - * to be deprecated. + * Optional. You can set this message if you need to deprecate an enum + * value. * * Generated from protobuf field string deprecated = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -43,13 +43,13 @@ class EnumValue extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type int $index - * Required. Index for the enum. Cannot be modified. + * Required. Index for the enum value. It can't be modified. * @type string $name * Required. Name of the enumvalue. This is the actual value that the - * aspect will contain. + * aspect can contain. * @type string $deprecated - * Optional. Optional deprecation message to be set if an enum value needs - * to be deprecated. + * Optional. You can set this message if you need to deprecate an enum + * value. * } */ public function __construct($data = NULL) { @@ -58,7 +58,7 @@ public function __construct($data = NULL) { } /** - * Required. Index for the enum. Cannot be modified. + * Required. Index for the enum value. It can't be modified. * * Generated from protobuf field int32 index = 1 [(.google.api.field_behavior) = REQUIRED]; * @return int @@ -69,7 +69,7 @@ public function getIndex() } /** - * Required. Index for the enum. Cannot be modified. + * Required. Index for the enum value. It can't be modified. * * Generated from protobuf field int32 index = 1 [(.google.api.field_behavior) = REQUIRED]; * @param int $var @@ -85,7 +85,7 @@ public function setIndex($var) /** * Required. Name of the enumvalue. This is the actual value that the - * aspect will contain. + * aspect can contain. * * Generated from protobuf field string name = 2 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -97,7 +97,7 @@ public function getName() /** * Required. Name of the enumvalue. This is the actual value that the - * aspect will contain. + * aspect can contain. * * Generated from protobuf field string name = 2 [(.google.api.field_behavior) = REQUIRED]; * @param string $var @@ -112,8 +112,8 @@ public function setName($var) } /** - * Optional. Optional deprecation message to be set if an enum value needs - * to be deprecated. + * Optional. You can set this message if you need to deprecate an enum + * value. * * Generated from protobuf field string deprecated = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -124,8 +124,8 @@ public function getDeprecated() } /** - * Optional. Optional deprecation message to be set if an enum value needs - * to be deprecated. + * Optional. You can set this message if you need to deprecate an enum + * value. * * Generated from protobuf field string deprecated = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/Dataplex/src/V1/CancelMetadataJobRequest.php b/Dataplex/src/V1/CancelMetadataJobRequest.php new file mode 100644 index 000000000000..4f45a95dabf2 --- /dev/null +++ b/Dataplex/src/V1/CancelMetadataJobRequest.php @@ -0,0 +1,86 @@ +google.cloud.dataplex.v1.CancelMetadataJobRequest + */ +class CancelMetadataJobRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the job, in the format + * `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The resource name of the job, in the format + * `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}` + * Please see {@see CatalogServiceClient::metadataJobName()} for help formatting this field. + * + * @return \Google\Cloud\Dataplex\V1\CancelMetadataJobRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the job, in the format + * `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\Catalog::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the job, in the format + * `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the job, in the format + * `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}` + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/Dataplex/src/V1/Client/CatalogServiceClient.php b/Dataplex/src/V1/Client/CatalogServiceClient.php index f9e51b12dcd4..2c3b4b006e32 100644 --- a/Dataplex/src/V1/Client/CatalogServiceClient.php +++ b/Dataplex/src/V1/Client/CatalogServiceClient.php @@ -35,10 +35,12 @@ use Google\ApiCore\ValidationException; use Google\Auth\FetchAuthTokenInterface; use Google\Cloud\Dataplex\V1\AspectType; +use Google\Cloud\Dataplex\V1\CancelMetadataJobRequest; use Google\Cloud\Dataplex\V1\CreateAspectTypeRequest; use Google\Cloud\Dataplex\V1\CreateEntryGroupRequest; use Google\Cloud\Dataplex\V1\CreateEntryRequest; use Google\Cloud\Dataplex\V1\CreateEntryTypeRequest; +use Google\Cloud\Dataplex\V1\CreateMetadataJobRequest; use Google\Cloud\Dataplex\V1\DeleteAspectTypeRequest; use Google\Cloud\Dataplex\V1\DeleteEntryGroupRequest; use Google\Cloud\Dataplex\V1\DeleteEntryRequest; @@ -50,11 +52,14 @@ use Google\Cloud\Dataplex\V1\GetEntryGroupRequest; use Google\Cloud\Dataplex\V1\GetEntryRequest; use Google\Cloud\Dataplex\V1\GetEntryTypeRequest; +use Google\Cloud\Dataplex\V1\GetMetadataJobRequest; use Google\Cloud\Dataplex\V1\ListAspectTypesRequest; use Google\Cloud\Dataplex\V1\ListEntriesRequest; use Google\Cloud\Dataplex\V1\ListEntryGroupsRequest; use Google\Cloud\Dataplex\V1\ListEntryTypesRequest; +use Google\Cloud\Dataplex\V1\ListMetadataJobsRequest; use Google\Cloud\Dataplex\V1\LookupEntryRequest; +use Google\Cloud\Dataplex\V1\MetadataJob; use Google\Cloud\Dataplex\V1\SearchEntriesRequest; use Google\Cloud\Dataplex\V1\UpdateAspectTypeRequest; use Google\Cloud\Dataplex\V1\UpdateEntryGroupRequest; @@ -74,10 +79,10 @@ /** * Service Description: The primary resources offered by this service are EntryGroups, EntryTypes, - * AspectTypes, Entry and Aspect which collectively allow a data administrator - * to organize, manage, secure and catalog data across their organization - * located across cloud projects in a variety of storage systems including Cloud - * Storage and BigQuery. + * AspectTypes, and Entries. They collectively let data administrators organize, + * manage, secure, and catalog data located across cloud projects in their + * organization in a variety of storage systems, including Cloud Storage and + * BigQuery. * * This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. @@ -87,10 +92,12 @@ * name, and additionally a parseName method to extract the individual identifiers * contained within formatted names that are returned by the API. * + * @method PromiseInterface cancelMetadataJobAsync(CancelMetadataJobRequest $request, array $optionalArgs = []) * @method PromiseInterface createAspectTypeAsync(CreateAspectTypeRequest $request, array $optionalArgs = []) * @method PromiseInterface createEntryAsync(CreateEntryRequest $request, array $optionalArgs = []) * @method PromiseInterface createEntryGroupAsync(CreateEntryGroupRequest $request, array $optionalArgs = []) * @method PromiseInterface createEntryTypeAsync(CreateEntryTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface createMetadataJobAsync(CreateMetadataJobRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteAspectTypeAsync(DeleteAspectTypeRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteEntryAsync(DeleteEntryRequest $request, array $optionalArgs = []) * @method PromiseInterface deleteEntryGroupAsync(DeleteEntryGroupRequest $request, array $optionalArgs = []) @@ -99,10 +106,12 @@ * @method PromiseInterface getEntryAsync(GetEntryRequest $request, array $optionalArgs = []) * @method PromiseInterface getEntryGroupAsync(GetEntryGroupRequest $request, array $optionalArgs = []) * @method PromiseInterface getEntryTypeAsync(GetEntryTypeRequest $request, array $optionalArgs = []) + * @method PromiseInterface getMetadataJobAsync(GetMetadataJobRequest $request, array $optionalArgs = []) * @method PromiseInterface listAspectTypesAsync(ListAspectTypesRequest $request, array $optionalArgs = []) * @method PromiseInterface listEntriesAsync(ListEntriesRequest $request, array $optionalArgs = []) * @method PromiseInterface listEntryGroupsAsync(ListEntryGroupsRequest $request, array $optionalArgs = []) * @method PromiseInterface listEntryTypesAsync(ListEntryTypesRequest $request, array $optionalArgs = []) + * @method PromiseInterface listMetadataJobsAsync(ListMetadataJobsRequest $request, array $optionalArgs = []) * @method PromiseInterface lookupEntryAsync(LookupEntryRequest $request, array $optionalArgs = []) * @method PromiseInterface searchEntriesAsync(SearchEntriesRequest $request, array $optionalArgs = []) * @method PromiseInterface updateAspectTypeAsync(UpdateAspectTypeRequest $request, array $optionalArgs = []) @@ -308,6 +317,25 @@ public static function locationName(string $project, string $location): string ]); } + /** + * Formats a string containing the fully-qualified path to represent a metadata_job + * resource. + * + * @param string $project + * @param string $location + * @param string $metadataJob + * + * @return string The formatted metadata_job resource. + */ + public static function metadataJobName(string $project, string $location, string $metadataJob): string + { + return self::getPathTemplate('metadataJob')->render([ + 'project' => $project, + 'location' => $location, + 'metadataJob' => $metadataJob, + ]); + } + /** * Parses a formatted name string and returns an associative array of the components in the name. * The following name formats are supported: @@ -317,6 +345,7 @@ public static function locationName(string $project, string $location): string * - entryGroup: projects/{project}/locations/{location}/entryGroups/{entry_group} * - entryType: projects/{project}/locations/{location}/entryTypes/{entry_type} * - location: projects/{project}/locations/{location} + * - metadataJob: projects/{project}/locations/{location}/metadataJobs/{metadataJob} * * The optional $template argument can be supplied to specify a particular pattern, * and must match one of the templates listed above. If no $template argument is @@ -409,7 +438,36 @@ public function __call($method, $args) } /** - * Creates an AspectType + * Cancels a metadata job. + * + * If you cancel a metadata import job that is in progress, the changes in the + * job might be partially applied. We recommend that you reset the state of + * the entry groups in your project by running another metadata job that + * reverts the changes from the canceled job. + * + * The async variant is {@see CatalogServiceClient::cancelMetadataJobAsync()} . + * + * @example samples/V1/CatalogServiceClient/cancel_metadata_job.php + * + * @param CancelMetadataJobRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @throws ApiException Thrown if the API call fails. + */ + public function cancelMetadataJob(CancelMetadataJobRequest $request, array $callOptions = []): void + { + $this->startApiCall('CancelMetadataJob', $request, $callOptions)->wait(); + } + + /** + * Creates an AspectType. * * The async variant is {@see CatalogServiceClient::createAspectTypeAsync()} . * @@ -461,7 +519,7 @@ public function createEntry(CreateEntryRequest $request, array $callOptions = [] } /** - * Creates an EntryGroup + * Creates an EntryGroup. * * The async variant is {@see CatalogServiceClient::createEntryGroupAsync()} . * @@ -487,7 +545,7 @@ public function createEntryGroup(CreateEntryGroupRequest $request, array $callOp } /** - * Creates an EntryType + * Creates an EntryType. * * The async variant is {@see CatalogServiceClient::createEntryTypeAsync()} . * @@ -513,7 +571,34 @@ public function createEntryType(CreateEntryTypeRequest $request, array $callOpti } /** - * Deletes a AspectType resource. + * Creates a metadata job. For example, use a metadata job to import Dataplex + * Catalog entries and aspects from a third-party system into Dataplex. + * + * The async variant is {@see CatalogServiceClient::createMetadataJobAsync()} . + * + * @example samples/V1/CatalogServiceClient/create_metadata_job.php + * + * @param CreateMetadataJobRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return OperationResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function createMetadataJob(CreateMetadataJobRequest $request, array $callOptions = []): OperationResponse + { + return $this->startApiCall('CreateMetadataJob', $request, $callOptions)->wait(); + } + + /** + * Deletes an AspectType. * * The async variant is {@see CatalogServiceClient::deleteAspectTypeAsync()} . * @@ -565,7 +650,7 @@ public function deleteEntry(DeleteEntryRequest $request, array $callOptions = [] } /** - * Deletes a EntryGroup resource. + * Deletes an EntryGroup. * * The async variant is {@see CatalogServiceClient::deleteEntryGroupAsync()} . * @@ -591,7 +676,7 @@ public function deleteEntryGroup(DeleteEntryGroupRequest $request, array $callOp } /** - * Deletes a EntryType resource. + * Deletes an EntryType. * * The async variant is {@see CatalogServiceClient::deleteEntryTypeAsync()} . * @@ -617,7 +702,7 @@ public function deleteEntryType(DeleteEntryTypeRequest $request, array $callOpti } /** - * Retrieves a AspectType resource. + * Gets an AspectType. * * The async variant is {@see CatalogServiceClient::getAspectTypeAsync()} . * @@ -643,7 +728,12 @@ public function getAspectType(GetAspectTypeRequest $request, array $callOptions } /** - * Gets a single entry. + * Gets an Entry. + * + * **Caution**: The BigQuery metadata that is stored in Dataplex Catalog is + * changing. For more information, see [Changes to BigQuery metadata stored in + * Dataplex + * Catalog](https://cloud.google.com/dataplex/docs/biqquery-metadata-changes). * * The async variant is {@see CatalogServiceClient::getEntryAsync()} . * @@ -669,7 +759,7 @@ public function getEntry(GetEntryRequest $request, array $callOptions = []): Ent } /** - * Retrieves a EntryGroup resource. + * Gets an EntryGroup. * * The async variant is {@see CatalogServiceClient::getEntryGroupAsync()} . * @@ -695,7 +785,7 @@ public function getEntryGroup(GetEntryGroupRequest $request, array $callOptions } /** - * Retrieves a EntryType resource. + * Gets an EntryType. * * The async variant is {@see CatalogServiceClient::getEntryTypeAsync()} . * @@ -720,6 +810,32 @@ public function getEntryType(GetEntryTypeRequest $request, array $callOptions = return $this->startApiCall('GetEntryType', $request, $callOptions)->wait(); } + /** + * Gets a metadata job. + * + * The async variant is {@see CatalogServiceClient::getMetadataJobAsync()} . + * + * @example samples/V1/CatalogServiceClient/get_metadata_job.php + * + * @param GetMetadataJobRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return MetadataJob + * + * @throws ApiException Thrown if the API call fails. + */ + public function getMetadataJob(GetMetadataJobRequest $request, array $callOptions = []): MetadataJob + { + return $this->startApiCall('GetMetadataJob', $request, $callOptions)->wait(); + } + /** * Lists AspectType resources in a project and location. * @@ -747,7 +863,7 @@ public function listAspectTypes(ListAspectTypesRequest $request, array $callOpti } /** - * Lists entries within an entry group. + * Lists Entries within an EntryGroup. * * The async variant is {@see CatalogServiceClient::listEntriesAsync()} . * @@ -825,7 +941,38 @@ public function listEntryTypes(ListEntryTypesRequest $request, array $callOption } /** - * Looks up a single entry. + * Lists metadata jobs. + * + * The async variant is {@see CatalogServiceClient::listMetadataJobsAsync()} . + * + * @example samples/V1/CatalogServiceClient/list_metadata_jobs.php + * + * @param ListMetadataJobsRequest $request A request to house fields associated with the call. + * @param array $callOptions { + * Optional. + * + * @type RetrySettings|array $retrySettings + * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an + * associative array of retry settings parameters. See the documentation on + * {@see RetrySettings} for example usage. + * } + * + * @return PagedListResponse + * + * @throws ApiException Thrown if the API call fails. + */ + public function listMetadataJobs(ListMetadataJobsRequest $request, array $callOptions = []): PagedListResponse + { + return $this->startApiCall('ListMetadataJobs', $request, $callOptions); + } + + /** + * Looks up a single Entry by name using the permission on the source system. + * + * **Caution**: The BigQuery metadata that is stored in Dataplex Catalog is + * changing. For more information, see [Changes to BigQuery metadata stored in + * Dataplex + * Catalog](https://cloud.google.com/dataplex/docs/biqquery-metadata-changes). * * The async variant is {@see CatalogServiceClient::lookupEntryAsync()} . * @@ -851,7 +998,7 @@ public function lookupEntry(LookupEntryRequest $request, array $callOptions = [] } /** - * Searches for entries matching given query and scope. + * Searches for Entries matching the given query and scope. * * The async variant is {@see CatalogServiceClient::searchEntriesAsync()} . * @@ -877,7 +1024,7 @@ public function searchEntries(SearchEntriesRequest $request, array $callOptions } /** - * Updates a AspectType resource. + * Updates an AspectType. * * The async variant is {@see CatalogServiceClient::updateAspectTypeAsync()} . * @@ -929,7 +1076,7 @@ public function updateEntry(UpdateEntryRequest $request, array $callOptions = [] } /** - * Updates a EntryGroup resource. + * Updates an EntryGroup. * * The async variant is {@see CatalogServiceClient::updateEntryGroupAsync()} . * @@ -955,7 +1102,7 @@ public function updateEntryGroup(UpdateEntryGroupRequest $request, array $callOp } /** - * Updates a EntryType resource. + * Updates an EntryType. * * The async variant is {@see CatalogServiceClient::updateEntryTypeAsync()} . * diff --git a/Dataplex/src/V1/Client/DataScanServiceClient.php b/Dataplex/src/V1/Client/DataScanServiceClient.php index 796f4f3c729d..3840a2497d10 100644 --- a/Dataplex/src/V1/Client/DataScanServiceClient.php +++ b/Dataplex/src/V1/Client/DataScanServiceClient.php @@ -185,6 +185,25 @@ private function createOperationsClient(array $options) return new OperationsClient($options); } + /** + * Formats a string containing the fully-qualified path to represent a connection + * resource. + * + * @param string $project + * @param string $location + * @param string $connection + * + * @return string The formatted connection resource. + */ + public static function connectionName(string $project, string $location, string $connection): string + { + return self::getPathTemplate('connection')->render([ + 'project' => $project, + 'location' => $location, + 'connection' => $connection, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a data_scan * resource. @@ -225,6 +244,23 @@ public static function dataScanJobName(string $project, string $location, string ]); } + /** + * Formats a string containing the fully-qualified path to represent a dataset + * resource. + * + * @param string $project + * @param string $dataset + * + * @return string The formatted dataset resource. + */ + public static function datasetName(string $project, string $dataset): string + { + return self::getPathTemplate('dataset')->render([ + 'project' => $project, + 'dataset' => $dataset, + ]); + } + /** * Formats a string containing the fully-qualified path to represent a entity * resource. @@ -274,8 +310,10 @@ public static function locationName(string $project, string $location): string * Parses a formatted name string and returns an associative array of the components in the name. * The following name formats are supported: * Template: Pattern + * - connection: projects/{project}/locations/{location}/connections/{connection} * - dataScan: projects/{project}/locations/{location}/dataScans/{dataScan} * - dataScanJob: projects/{project}/locations/{location}/dataScans/{dataScan}/jobs/{job} + * - dataset: projects/{project}/datasets/{dataset} * - entity: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity} * - location: projects/{project}/locations/{location} * diff --git a/Dataplex/src/V1/CreateAspectTypeRequest.php b/Dataplex/src/V1/CreateAspectTypeRequest.php index 265c62c444db..f8e32e827807 100644 --- a/Dataplex/src/V1/CreateAspectTypeRequest.php +++ b/Dataplex/src/V1/CreateAspectTypeRequest.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Create AspectType Request + * Create AspectType Request. * * Generated from protobuf message google.cloud.dataplex.v1.CreateAspectTypeRequest */ @@ -18,7 +18,7 @@ class CreateAspectTypeRequest extends \Google\Protobuf\Internal\Message /** * Required. The resource name of the AspectType, of the form: * projects/{project_number}/locations/{location_id} - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -30,14 +30,14 @@ class CreateAspectTypeRequest extends \Google\Protobuf\Internal\Message */ protected $aspect_type_id = ''; /** - * Required. AspectType Resource + * Required. AspectType Resource. * * Generated from protobuf field .google.cloud.dataplex.v1.AspectType aspect_type = 3 [(.google.api.field_behavior) = REQUIRED]; */ protected $aspect_type = null; /** - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -46,9 +46,9 @@ class CreateAspectTypeRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The resource name of the AspectType, of the form: * projects/{project_number}/locations/{location_id} - * where `location_id` refers to a GCP region. Please see + * where `location_id` refers to a Google Cloud region. Please see * {@see CatalogServiceClient::locationName()} for help formatting this field. - * @param \Google\Cloud\Dataplex\V1\AspectType $aspectType Required. AspectType Resource + * @param \Google\Cloud\Dataplex\V1\AspectType $aspectType Required. AspectType Resource. * @param string $aspectTypeId Required. AspectType identifier. * * @return \Google\Cloud\Dataplex\V1\CreateAspectTypeRequest @@ -72,14 +72,14 @@ public static function build(string $parent, \Google\Cloud\Dataplex\V1\AspectTyp * @type string $parent * Required. The resource name of the AspectType, of the form: * projects/{project_number}/locations/{location_id} - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * @type string $aspect_type_id * Required. AspectType identifier. * @type \Google\Cloud\Dataplex\V1\AspectType $aspect_type - * Required. AspectType Resource + * Required. AspectType Resource. * @type bool $validate_only - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * } */ public function __construct($data = NULL) { @@ -90,7 +90,7 @@ public function __construct($data = NULL) { /** * Required. The resource name of the AspectType, of the form: * projects/{project_number}/locations/{location_id} - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -103,7 +103,7 @@ public function getParent() /** * Required. The resource name of the AspectType, of the form: * projects/{project_number}/locations/{location_id} - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -144,7 +144,7 @@ public function setAspectTypeId($var) } /** - * Required. AspectType Resource + * Required. AspectType Resource. * * Generated from protobuf field .google.cloud.dataplex.v1.AspectType aspect_type = 3 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\Dataplex\V1\AspectType|null @@ -165,7 +165,7 @@ public function clearAspectType() } /** - * Required. AspectType Resource + * Required. AspectType Resource. * * Generated from protobuf field .google.cloud.dataplex.v1.AspectType aspect_type = 3 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\Dataplex\V1\AspectType $var @@ -180,8 +180,8 @@ public function setAspectType($var) } /** - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -192,8 +192,8 @@ public function getValidateOnly() } /** - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/Dataplex/src/V1/CreateEntryGroupRequest.php b/Dataplex/src/V1/CreateEntryGroupRequest.php index ddda7b08816b..af3c0b5232bc 100644 --- a/Dataplex/src/V1/CreateEntryGroupRequest.php +++ b/Dataplex/src/V1/CreateEntryGroupRequest.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Create EntryGroup Request + * Create EntryGroup Request. * * Generated from protobuf message google.cloud.dataplex.v1.CreateEntryGroupRequest */ @@ -30,14 +30,14 @@ class CreateEntryGroupRequest extends \Google\Protobuf\Internal\Message */ protected $entry_group_id = ''; /** - * Required. EntryGroup Resource + * Required. EntryGroup Resource. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryGroup entry_group = 3 [(.google.api.field_behavior) = REQUIRED]; */ protected $entry_group = null; /** - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -48,7 +48,7 @@ class CreateEntryGroupRequest extends \Google\Protobuf\Internal\Message * projects/{project_number}/locations/{location_id} * where `location_id` refers to a GCP region. Please see * {@see CatalogServiceClient::locationName()} for help formatting this field. - * @param \Google\Cloud\Dataplex\V1\EntryGroup $entryGroup Required. EntryGroup Resource + * @param \Google\Cloud\Dataplex\V1\EntryGroup $entryGroup Required. EntryGroup Resource. * @param string $entryGroupId Required. EntryGroup identifier. * * @return \Google\Cloud\Dataplex\V1\CreateEntryGroupRequest @@ -76,10 +76,10 @@ public static function build(string $parent, \Google\Cloud\Dataplex\V1\EntryGrou * @type string $entry_group_id * Required. EntryGroup identifier. * @type \Google\Cloud\Dataplex\V1\EntryGroup $entry_group - * Required. EntryGroup Resource + * Required. EntryGroup Resource. * @type bool $validate_only - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * } */ public function __construct($data = NULL) { @@ -144,7 +144,7 @@ public function setEntryGroupId($var) } /** - * Required. EntryGroup Resource + * Required. EntryGroup Resource. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryGroup entry_group = 3 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\Dataplex\V1\EntryGroup|null @@ -165,7 +165,7 @@ public function clearEntryGroup() } /** - * Required. EntryGroup Resource + * Required. EntryGroup Resource. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryGroup entry_group = 3 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\Dataplex\V1\EntryGroup $var @@ -180,8 +180,8 @@ public function setEntryGroup($var) } /** - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -192,8 +192,8 @@ public function getValidateOnly() } /** - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/Dataplex/src/V1/CreateEntryRequest.php b/Dataplex/src/V1/CreateEntryRequest.php index 0d76b839f4bd..70f94ce075ca 100644 --- a/Dataplex/src/V1/CreateEntryRequest.php +++ b/Dataplex/src/V1/CreateEntryRequest.php @@ -9,6 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** + * Create Entry request. + * * Generated from protobuf message google.cloud.dataplex.v1.CreateEntryRequest */ class CreateEntryRequest extends \Google\Protobuf\Internal\Message @@ -22,18 +24,19 @@ class CreateEntryRequest extends \Google\Protobuf\Internal\Message protected $parent = ''; /** * Required. Entry identifier. It has to be unique within an Entry Group. - * Entries corresponding to Google Cloud resources use Entry ID format based - * on Full Resource Names - * (https://cloud.google.com/apis/design/resource_names#full_resource_name). - * The format is a Full Resource Name of the resource without the - * prefix double slashes in the API Service Name part of Full Resource Name. - * This allows retrieval of entries using their associated resource name. - * For example if the Full Resource Name of a resource is + * Entries corresponding to Google Cloud resources use an Entry ID format + * based on [full resource + * names](https://cloud.google.com/apis/design/resource_names#full_resource_name). + * The format is a full resource name of the resource without the + * prefix double slashes in the API service name part of the full resource + * name. This allows retrieval of entries using their associated resource + * name. + * For example, if the full resource name of a resource is * `//library.googleapis.com/shelves/shelf1/books/book2`, * then the suggested entry_id is * `library.googleapis.com/shelves/shelf1/books/book2`. * It is also suggested to follow the same convention for entries - * corresponding to resources from other providers or systems than Google + * corresponding to resources from providers or systems other than Google * Cloud. * The maximum size of the field is 4000 characters. * @@ -54,20 +57,21 @@ class CreateEntryRequest extends \Google\Protobuf\Internal\Message * @param \Google\Cloud\Dataplex\V1\Entry $entry Required. Entry resource. * @param string $entryId Required. Entry identifier. It has to be unique within an Entry Group. * - * Entries corresponding to Google Cloud resources use Entry ID format based - * on Full Resource Names - * (https://cloud.google.com/apis/design/resource_names#full_resource_name). - * The format is a Full Resource Name of the resource without the - * prefix double slashes in the API Service Name part of Full Resource Name. - * This allows retrieval of entries using their associated resource name. + * Entries corresponding to Google Cloud resources use an Entry ID format + * based on [full resource + * names](https://cloud.google.com/apis/design/resource_names#full_resource_name). + * The format is a full resource name of the resource without the + * prefix double slashes in the API service name part of the full resource + * name. This allows retrieval of entries using their associated resource + * name. * - * For example if the Full Resource Name of a resource is + * For example, if the full resource name of a resource is * `//library.googleapis.com/shelves/shelf1/books/book2`, * then the suggested entry_id is * `library.googleapis.com/shelves/shelf1/books/book2`. * * It is also suggested to follow the same convention for entries - * corresponding to resources from other providers or systems than Google + * corresponding to resources from providers or systems other than Google * Cloud. * * The maximum size of the field is 4000 characters. @@ -95,18 +99,19 @@ public static function build(string $parent, \Google\Cloud\Dataplex\V1\Entry $en * `projects/{project}/locations/{location}/entryGroups/{entry_group}`. * @type string $entry_id * Required. Entry identifier. It has to be unique within an Entry Group. - * Entries corresponding to Google Cloud resources use Entry ID format based - * on Full Resource Names - * (https://cloud.google.com/apis/design/resource_names#full_resource_name). - * The format is a Full Resource Name of the resource without the - * prefix double slashes in the API Service Name part of Full Resource Name. - * This allows retrieval of entries using their associated resource name. - * For example if the Full Resource Name of a resource is + * Entries corresponding to Google Cloud resources use an Entry ID format + * based on [full resource + * names](https://cloud.google.com/apis/design/resource_names#full_resource_name). + * The format is a full resource name of the resource without the + * prefix double slashes in the API service name part of the full resource + * name. This allows retrieval of entries using their associated resource + * name. + * For example, if the full resource name of a resource is * `//library.googleapis.com/shelves/shelf1/books/book2`, * then the suggested entry_id is * `library.googleapis.com/shelves/shelf1/books/book2`. * It is also suggested to follow the same convention for entries - * corresponding to resources from other providers or systems than Google + * corresponding to resources from providers or systems other than Google * Cloud. * The maximum size of the field is 4000 characters. * @type \Google\Cloud\Dataplex\V1\Entry $entry @@ -148,18 +153,19 @@ public function setParent($var) /** * Required. Entry identifier. It has to be unique within an Entry Group. - * Entries corresponding to Google Cloud resources use Entry ID format based - * on Full Resource Names - * (https://cloud.google.com/apis/design/resource_names#full_resource_name). - * The format is a Full Resource Name of the resource without the - * prefix double slashes in the API Service Name part of Full Resource Name. - * This allows retrieval of entries using their associated resource name. - * For example if the Full Resource Name of a resource is + * Entries corresponding to Google Cloud resources use an Entry ID format + * based on [full resource + * names](https://cloud.google.com/apis/design/resource_names#full_resource_name). + * The format is a full resource name of the resource without the + * prefix double slashes in the API service name part of the full resource + * name. This allows retrieval of entries using their associated resource + * name. + * For example, if the full resource name of a resource is * `//library.googleapis.com/shelves/shelf1/books/book2`, * then the suggested entry_id is * `library.googleapis.com/shelves/shelf1/books/book2`. * It is also suggested to follow the same convention for entries - * corresponding to resources from other providers or systems than Google + * corresponding to resources from providers or systems other than Google * Cloud. * The maximum size of the field is 4000 characters. * @@ -173,18 +179,19 @@ public function getEntryId() /** * Required. Entry identifier. It has to be unique within an Entry Group. - * Entries corresponding to Google Cloud resources use Entry ID format based - * on Full Resource Names - * (https://cloud.google.com/apis/design/resource_names#full_resource_name). - * The format is a Full Resource Name of the resource without the - * prefix double slashes in the API Service Name part of Full Resource Name. - * This allows retrieval of entries using their associated resource name. - * For example if the Full Resource Name of a resource is + * Entries corresponding to Google Cloud resources use an Entry ID format + * based on [full resource + * names](https://cloud.google.com/apis/design/resource_names#full_resource_name). + * The format is a full resource name of the resource without the + * prefix double slashes in the API service name part of the full resource + * name. This allows retrieval of entries using their associated resource + * name. + * For example, if the full resource name of a resource is * `//library.googleapis.com/shelves/shelf1/books/book2`, * then the suggested entry_id is * `library.googleapis.com/shelves/shelf1/books/book2`. * It is also suggested to follow the same convention for entries - * corresponding to resources from other providers or systems than Google + * corresponding to resources from providers or systems other than Google * Cloud. * The maximum size of the field is 4000 characters. * diff --git a/Dataplex/src/V1/CreateEntryTypeRequest.php b/Dataplex/src/V1/CreateEntryTypeRequest.php index 86b2c2c7f620..3e1052d7012d 100644 --- a/Dataplex/src/V1/CreateEntryTypeRequest.php +++ b/Dataplex/src/V1/CreateEntryTypeRequest.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Create EntryType Request + * Create EntryType Request. * * Generated from protobuf message google.cloud.dataplex.v1.CreateEntryTypeRequest */ @@ -18,7 +18,7 @@ class CreateEntryTypeRequest extends \Google\Protobuf\Internal\Message /** * Required. The resource name of the EntryType, of the form: * projects/{project_number}/locations/{location_id} - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ @@ -30,14 +30,14 @@ class CreateEntryTypeRequest extends \Google\Protobuf\Internal\Message */ protected $entry_type_id = ''; /** - * Required. EntryType Resource + * Required. EntryType Resource. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryType entry_type = 3 [(.google.api.field_behavior) = REQUIRED]; */ protected $entry_type = null; /** - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -46,9 +46,9 @@ class CreateEntryTypeRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The resource name of the EntryType, of the form: * projects/{project_number}/locations/{location_id} - * where `location_id` refers to a GCP region. Please see + * where `location_id` refers to a Google Cloud region. Please see * {@see CatalogServiceClient::locationName()} for help formatting this field. - * @param \Google\Cloud\Dataplex\V1\EntryType $entryType Required. EntryType Resource + * @param \Google\Cloud\Dataplex\V1\EntryType $entryType Required. EntryType Resource. * @param string $entryTypeId Required. EntryType identifier. * * @return \Google\Cloud\Dataplex\V1\CreateEntryTypeRequest @@ -72,14 +72,14 @@ public static function build(string $parent, \Google\Cloud\Dataplex\V1\EntryType * @type string $parent * Required. The resource name of the EntryType, of the form: * projects/{project_number}/locations/{location_id} - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * @type string $entry_type_id * Required. EntryType identifier. * @type \Google\Cloud\Dataplex\V1\EntryType $entry_type - * Required. EntryType Resource + * Required. EntryType Resource. * @type bool $validate_only - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * } */ public function __construct($data = NULL) { @@ -90,7 +90,7 @@ public function __construct($data = NULL) { /** * Required. The resource name of the EntryType, of the form: * projects/{project_number}/locations/{location_id} - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -103,7 +103,7 @@ public function getParent() /** * Required. The resource name of the EntryType, of the form: * projects/{project_number}/locations/{location_id} - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -144,7 +144,7 @@ public function setEntryTypeId($var) } /** - * Required. EntryType Resource + * Required. EntryType Resource. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryType entry_type = 3 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\Dataplex\V1\EntryType|null @@ -165,7 +165,7 @@ public function clearEntryType() } /** - * Required. EntryType Resource + * Required. EntryType Resource. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryType entry_type = 3 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\Dataplex\V1\EntryType $var @@ -180,8 +180,8 @@ public function setEntryType($var) } /** - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -192,8 +192,8 @@ public function getValidateOnly() } /** - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/Dataplex/src/V1/CreateMetadataJobRequest.php b/Dataplex/src/V1/CreateMetadataJobRequest.php new file mode 100644 index 000000000000..ba5a1af1802d --- /dev/null +++ b/Dataplex/src/V1/CreateMetadataJobRequest.php @@ -0,0 +1,211 @@ +google.cloud.dataplex.v1.CreateMetadataJobRequest + */ +class CreateMetadataJobRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the parent location, in the format + * `projects/{project_id_or_number}/locations/{location_id}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Required. The metadata job resource. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob metadata_job = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $metadata_job = null; + /** + * Optional. The metadata job ID. If not provided, a unique ID is generated + * with the prefix `metadata-job-`. + * + * Generated from protobuf field string metadata_job_id = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $metadata_job_id = ''; + /** + * Optional. The service validates the request without performing any + * mutations. The default is false. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $validate_only = false; + + /** + * @param string $parent Required. The resource name of the parent location, in the format + * `projects/{project_id_or_number}/locations/{location_id}` + * Please see {@see CatalogServiceClient::locationName()} for help formatting this field. + * @param \Google\Cloud\Dataplex\V1\MetadataJob $metadataJob Required. The metadata job resource. + * @param string $metadataJobId Optional. The metadata job ID. If not provided, a unique ID is generated + * with the prefix `metadata-job-`. + * + * @return \Google\Cloud\Dataplex\V1\CreateMetadataJobRequest + * + * @experimental + */ + public static function build(string $parent, \Google\Cloud\Dataplex\V1\MetadataJob $metadataJob, string $metadataJobId): self + { + return (new self()) + ->setParent($parent) + ->setMetadataJob($metadataJob) + ->setMetadataJobId($metadataJobId); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The resource name of the parent location, in the format + * `projects/{project_id_or_number}/locations/{location_id}` + * @type \Google\Cloud\Dataplex\V1\MetadataJob $metadata_job + * Required. The metadata job resource. + * @type string $metadata_job_id + * Optional. The metadata job ID. If not provided, a unique ID is generated + * with the prefix `metadata-job-`. + * @type bool $validate_only + * Optional. The service validates the request without performing any + * mutations. The default is false. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\Catalog::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the parent location, in the format + * `projects/{project_id_or_number}/locations/{location_id}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The resource name of the parent location, in the format + * `projects/{project_id_or_number}/locations/{location_id}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Required. The metadata job resource. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob metadata_job = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Dataplex\V1\MetadataJob|null + */ + public function getMetadataJob() + { + return $this->metadata_job; + } + + public function hasMetadataJob() + { + return isset($this->metadata_job); + } + + public function clearMetadataJob() + { + unset($this->metadata_job); + } + + /** + * Required. The metadata job resource. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob metadata_job = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Dataplex\V1\MetadataJob $var + * @return $this + */ + public function setMetadataJob($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\MetadataJob::class); + $this->metadata_job = $var; + + return $this; + } + + /** + * Optional. The metadata job ID. If not provided, a unique ID is generated + * with the prefix `metadata-job-`. + * + * Generated from protobuf field string metadata_job_id = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getMetadataJobId() + { + return $this->metadata_job_id; + } + + /** + * Optional. The metadata job ID. If not provided, a unique ID is generated + * with the prefix `metadata-job-`. + * + * Generated from protobuf field string metadata_job_id = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setMetadataJobId($var) + { + GPBUtil::checkString($var, True); + $this->metadata_job_id = $var; + + return $this; + } + + /** + * Optional. The service validates the request without performing any + * mutations. The default is false. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getValidateOnly() + { + return $this->validate_only; + } + + /** + * Optional. The service validates the request without performing any + * mutations. The default is false. + * + * Generated from protobuf field bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setValidateOnly($var) + { + GPBUtil::checkBool($var); + $this->validate_only = $var; + + return $this; + } + +} + diff --git a/Dataplex/src/V1/DataDiscoveryResult.php b/Dataplex/src/V1/DataDiscoveryResult.php new file mode 100644 index 000000000000..827ab48c8950 --- /dev/null +++ b/Dataplex/src/V1/DataDiscoveryResult.php @@ -0,0 +1,77 @@ +google.cloud.dataplex.v1.DataDiscoveryResult + */ +class DataDiscoveryResult extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. Configuration for metadata publishing. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoveryResult.BigQueryPublishing bigquery_publishing = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $bigquery_publishing = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Dataplex\V1\DataDiscoveryResult\BigQueryPublishing $bigquery_publishing + * Output only. Configuration for metadata publishing. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\DataDiscovery::initOnce(); + parent::__construct($data); + } + + /** + * Output only. Configuration for metadata publishing. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoveryResult.BigQueryPublishing bigquery_publishing = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\Dataplex\V1\DataDiscoveryResult\BigQueryPublishing|null + */ + public function getBigqueryPublishing() + { + return $this->bigquery_publishing; + } + + public function hasBigqueryPublishing() + { + return isset($this->bigquery_publishing); + } + + public function clearBigqueryPublishing() + { + unset($this->bigquery_publishing); + } + + /** + * Output only. Configuration for metadata publishing. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoveryResult.BigQueryPublishing bigquery_publishing = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\Dataplex\V1\DataDiscoveryResult\BigQueryPublishing $var + * @return $this + */ + public function setBigqueryPublishing($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\DataDiscoveryResult\BigQueryPublishing::class); + $this->bigquery_publishing = $var; + + return $this; + } + +} + diff --git a/Dataplex/src/V1/DataDiscoveryResult/BigQueryPublishing.php b/Dataplex/src/V1/DataDiscoveryResult/BigQueryPublishing.php new file mode 100644 index 000000000000..4fbda6fd6fa4 --- /dev/null +++ b/Dataplex/src/V1/DataDiscoveryResult/BigQueryPublishing.php @@ -0,0 +1,76 @@ +google.cloud.dataplex.v1.DataDiscoveryResult.BigQueryPublishing + */ +class BigQueryPublishing extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. The BigQuery dataset to publish to. It takes the form + * `projects/{project_id}/datasets/{dataset_id}`. + * If not set, the service creates a default publishing dataset. + * + * Generated from protobuf field string dataset = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + */ + protected $dataset = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $dataset + * Output only. The BigQuery dataset to publish to. It takes the form + * `projects/{project_id}/datasets/{dataset_id}`. + * If not set, the service creates a default publishing dataset. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\DataDiscovery::initOnce(); + parent::__construct($data); + } + + /** + * Output only. The BigQuery dataset to publish to. It takes the form + * `projects/{project_id}/datasets/{dataset_id}`. + * If not set, the service creates a default publishing dataset. + * + * Generated from protobuf field string dataset = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @return string + */ + public function getDataset() + { + return $this->dataset; + } + + /** + * Output only. The BigQuery dataset to publish to. It takes the form + * `projects/{project_id}/datasets/{dataset_id}`. + * If not set, the service creates a default publishing dataset. + * + * Generated from protobuf field string dataset = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setDataset($var) + { + GPBUtil::checkString($var, True); + $this->dataset = $var; + + return $this; + } + +} + + diff --git a/Dataplex/src/V1/DataDiscoverySpec.php b/Dataplex/src/V1/DataDiscoverySpec.php new file mode 100644 index 000000000000..799dceb7d9c7 --- /dev/null +++ b/Dataplex/src/V1/DataDiscoverySpec.php @@ -0,0 +1,119 @@ +google.cloud.dataplex.v1.DataDiscoverySpec + */ +class DataDiscoverySpec extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Configuration for metadata publishing. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec.BigQueryPublishingConfig bigquery_publishing_config = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $bigquery_publishing_config = null; + protected $resource_config; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Dataplex\V1\DataDiscoverySpec\BigQueryPublishingConfig $bigquery_publishing_config + * Optional. Configuration for metadata publishing. + * @type \Google\Cloud\Dataplex\V1\DataDiscoverySpec\StorageConfig $storage_config + * Cloud Storage related configurations. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\DataDiscovery::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Configuration for metadata publishing. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec.BigQueryPublishingConfig bigquery_publishing_config = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Dataplex\V1\DataDiscoverySpec\BigQueryPublishingConfig|null + */ + public function getBigqueryPublishingConfig() + { + return $this->bigquery_publishing_config; + } + + public function hasBigqueryPublishingConfig() + { + return isset($this->bigquery_publishing_config); + } + + public function clearBigqueryPublishingConfig() + { + unset($this->bigquery_publishing_config); + } + + /** + * Optional. Configuration for metadata publishing. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec.BigQueryPublishingConfig bigquery_publishing_config = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Dataplex\V1\DataDiscoverySpec\BigQueryPublishingConfig $var + * @return $this + */ + public function setBigqueryPublishingConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\DataDiscoverySpec\BigQueryPublishingConfig::class); + $this->bigquery_publishing_config = $var; + + return $this; + } + + /** + * Cloud Storage related configurations. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec.StorageConfig storage_config = 100; + * @return \Google\Cloud\Dataplex\V1\DataDiscoverySpec\StorageConfig|null + */ + public function getStorageConfig() + { + return $this->readOneof(100); + } + + public function hasStorageConfig() + { + return $this->hasOneof(100); + } + + /** + * Cloud Storage related configurations. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec.StorageConfig storage_config = 100; + * @param \Google\Cloud\Dataplex\V1\DataDiscoverySpec\StorageConfig $var + * @return $this + */ + public function setStorageConfig($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\DataDiscoverySpec\StorageConfig::class); + $this->writeOneof(100, $var); + + return $this; + } + + /** + * @return string + */ + public function getResourceConfig() + { + return $this->whichOneof("resource_config"); + } + +} + diff --git a/Dataplex/src/V1/DataDiscoverySpec/BigQueryPublishingConfig.php b/Dataplex/src/V1/DataDiscoverySpec/BigQueryPublishingConfig.php new file mode 100644 index 000000000000..cc6bba6bb218 --- /dev/null +++ b/Dataplex/src/V1/DataDiscoverySpec/BigQueryPublishingConfig.php @@ -0,0 +1,114 @@ +google.cloud.dataplex.v1.DataDiscoverySpec.BigQueryPublishingConfig + */ +class BigQueryPublishingConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Determines whether to publish discovered tables as BigLake + * external tables or non-BigLake external tables. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec.BigQueryPublishingConfig.TableType table_type = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $table_type = 0; + /** + * Optional. The BigQuery connection used to create BigLake tables. + * Must be in the form + * `projects/{project_id}/locations/{location_id}/connections/{connection_id}` + * + * Generated from protobuf field string connection = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + protected $connection = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $table_type + * Optional. Determines whether to publish discovered tables as BigLake + * external tables or non-BigLake external tables. + * @type string $connection + * Optional. The BigQuery connection used to create BigLake tables. + * Must be in the form + * `projects/{project_id}/locations/{location_id}/connections/{connection_id}` + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\DataDiscovery::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Determines whether to publish discovered tables as BigLake + * external tables or non-BigLake external tables. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec.BigQueryPublishingConfig.TableType table_type = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getTableType() + { + return $this->table_type; + } + + /** + * Optional. Determines whether to publish discovered tables as BigLake + * external tables or non-BigLake external tables. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec.BigQueryPublishingConfig.TableType table_type = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setTableType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Dataplex\V1\DataDiscoverySpec\BigQueryPublishingConfig\TableType::class); + $this->table_type = $var; + + return $this; + } + + /** + * Optional. The BigQuery connection used to create BigLake tables. + * Must be in the form + * `projects/{project_id}/locations/{location_id}/connections/{connection_id}` + * + * Generated from protobuf field string connection = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return string + */ + public function getConnection() + { + return $this->connection; + } + + /** + * Optional. The BigQuery connection used to create BigLake tables. + * Must be in the form + * `projects/{project_id}/locations/{location_id}/connections/{connection_id}` + * + * Generated from protobuf field string connection = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setConnection($var) + { + GPBUtil::checkString($var, True); + $this->connection = $var; + + return $this; + } + +} + + diff --git a/Dataplex/src/V1/DataDiscoverySpec/BigQueryPublishingConfig/TableType.php b/Dataplex/src/V1/DataDiscoverySpec/BigQueryPublishingConfig/TableType.php new file mode 100644 index 000000000000..cbd7286d3470 --- /dev/null +++ b/Dataplex/src/V1/DataDiscoverySpec/BigQueryPublishingConfig/TableType.php @@ -0,0 +1,66 @@ +google.cloud.dataplex.v1.DataDiscoverySpec.BigQueryPublishingConfig.TableType + */ +class TableType +{ + /** + * Table type unspecified. + * + * Generated from protobuf enum TABLE_TYPE_UNSPECIFIED = 0; + */ + const TABLE_TYPE_UNSPECIFIED = 0; + /** + * Default. Discovered tables are published as BigQuery external tables + * whose data is accessed using the credentials of the user querying the + * table. + * + * Generated from protobuf enum EXTERNAL = 1; + */ + const EXTERNAL = 1; + /** + * Discovered tables are published as BigLake external tables whose data + * is accessed using the credentials of the associated BigQuery + * connection. + * + * Generated from protobuf enum BIGLAKE = 2; + */ + const BIGLAKE = 2; + + private static $valueToName = [ + self::TABLE_TYPE_UNSPECIFIED => 'TABLE_TYPE_UNSPECIFIED', + self::EXTERNAL => 'EXTERNAL', + self::BIGLAKE => 'BIGLAKE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Dataplex/src/V1/DataDiscoverySpec/StorageConfig.php b/Dataplex/src/V1/DataDiscoverySpec/StorageConfig.php new file mode 100644 index 000000000000..d5c277811ffd --- /dev/null +++ b/Dataplex/src/V1/DataDiscoverySpec/StorageConfig.php @@ -0,0 +1,226 @@ +google.cloud.dataplex.v1.DataDiscoverySpec.StorageConfig + */ +class StorageConfig extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. Defines the data to include during discovery when only a subset + * of the data should be considered. Provide a list of patterns that + * identify the data to include. For Cloud Storage bucket assets, these + * patterns are interpreted as glob patterns used to match object names. For + * BigQuery dataset assets, these patterns are interpreted as patterns to + * match table names. + * + * Generated from protobuf field repeated string include_patterns = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $include_patterns; + /** + * Optional. Defines the data to exclude during discovery. Provide a list of + * patterns that identify the data to exclude. For Cloud Storage bucket + * assets, these patterns are interpreted as glob patterns used to match + * object names. For BigQuery dataset assets, these patterns are interpreted + * as patterns to match table names. + * + * Generated from protobuf field repeated string exclude_patterns = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $exclude_patterns; + /** + * Optional. Configuration for CSV data. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec.StorageConfig.CsvOptions csv_options = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $csv_options = null; + /** + * Optional. Configuration for JSON data. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec.StorageConfig.JsonOptions json_options = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $json_options = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|\Google\Protobuf\Internal\RepeatedField $include_patterns + * Optional. Defines the data to include during discovery when only a subset + * of the data should be considered. Provide a list of patterns that + * identify the data to include. For Cloud Storage bucket assets, these + * patterns are interpreted as glob patterns used to match object names. For + * BigQuery dataset assets, these patterns are interpreted as patterns to + * match table names. + * @type array|\Google\Protobuf\Internal\RepeatedField $exclude_patterns + * Optional. Defines the data to exclude during discovery. Provide a list of + * patterns that identify the data to exclude. For Cloud Storage bucket + * assets, these patterns are interpreted as glob patterns used to match + * object names. For BigQuery dataset assets, these patterns are interpreted + * as patterns to match table names. + * @type \Google\Cloud\Dataplex\V1\DataDiscoverySpec\StorageConfig\CsvOptions $csv_options + * Optional. Configuration for CSV data. + * @type \Google\Cloud\Dataplex\V1\DataDiscoverySpec\StorageConfig\JsonOptions $json_options + * Optional. Configuration for JSON data. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\DataDiscovery::initOnce(); + parent::__construct($data); + } + + /** + * Optional. Defines the data to include during discovery when only a subset + * of the data should be considered. Provide a list of patterns that + * identify the data to include. For Cloud Storage bucket assets, these + * patterns are interpreted as glob patterns used to match object names. For + * BigQuery dataset assets, these patterns are interpreted as patterns to + * match table names. + * + * Generated from protobuf field repeated string include_patterns = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getIncludePatterns() + { + return $this->include_patterns; + } + + /** + * Optional. Defines the data to include during discovery when only a subset + * of the data should be considered. Provide a list of patterns that + * identify the data to include. For Cloud Storage bucket assets, these + * patterns are interpreted as glob patterns used to match object names. For + * BigQuery dataset assets, these patterns are interpreted as patterns to + * match table names. + * + * Generated from protobuf field repeated string include_patterns = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setIncludePatterns($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->include_patterns = $arr; + + return $this; + } + + /** + * Optional. Defines the data to exclude during discovery. Provide a list of + * patterns that identify the data to exclude. For Cloud Storage bucket + * assets, these patterns are interpreted as glob patterns used to match + * object names. For BigQuery dataset assets, these patterns are interpreted + * as patterns to match table names. + * + * Generated from protobuf field repeated string exclude_patterns = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getExcludePatterns() + { + return $this->exclude_patterns; + } + + /** + * Optional. Defines the data to exclude during discovery. Provide a list of + * patterns that identify the data to exclude. For Cloud Storage bucket + * assets, these patterns are interpreted as glob patterns used to match + * object names. For BigQuery dataset assets, these patterns are interpreted + * as patterns to match table names. + * + * Generated from protobuf field repeated string exclude_patterns = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setExcludePatterns($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->exclude_patterns = $arr; + + return $this; + } + + /** + * Optional. Configuration for CSV data. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec.StorageConfig.CsvOptions csv_options = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Dataplex\V1\DataDiscoverySpec\StorageConfig\CsvOptions|null + */ + public function getCsvOptions() + { + return $this->csv_options; + } + + public function hasCsvOptions() + { + return isset($this->csv_options); + } + + public function clearCsvOptions() + { + unset($this->csv_options); + } + + /** + * Optional. Configuration for CSV data. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec.StorageConfig.CsvOptions csv_options = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Dataplex\V1\DataDiscoverySpec\StorageConfig\CsvOptions $var + * @return $this + */ + public function setCsvOptions($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\DataDiscoverySpec\StorageConfig\CsvOptions::class); + $this->csv_options = $var; + + return $this; + } + + /** + * Optional. Configuration for JSON data. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec.StorageConfig.JsonOptions json_options = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Cloud\Dataplex\V1\DataDiscoverySpec\StorageConfig\JsonOptions|null + */ + public function getJsonOptions() + { + return $this->json_options; + } + + public function hasJsonOptions() + { + return isset($this->json_options); + } + + public function clearJsonOptions() + { + unset($this->json_options); + } + + /** + * Optional. Configuration for JSON data. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec.StorageConfig.JsonOptions json_options = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Cloud\Dataplex\V1\DataDiscoverySpec\StorageConfig\JsonOptions $var + * @return $this + */ + public function setJsonOptions($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\DataDiscoverySpec\StorageConfig\JsonOptions::class); + $this->json_options = $var; + + return $this; + } + +} + + diff --git a/Dataplex/src/V1/DataDiscoverySpec/StorageConfig/CsvOptions.php b/Dataplex/src/V1/DataDiscoverySpec/StorageConfig/CsvOptions.php new file mode 100644 index 000000000000..aef60d21de59 --- /dev/null +++ b/Dataplex/src/V1/DataDiscoverySpec/StorageConfig/CsvOptions.php @@ -0,0 +1,224 @@ +google.cloud.dataplex.v1.DataDiscoverySpec.StorageConfig.CsvOptions + */ +class CsvOptions extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The number of rows to interpret as header rows that should be + * skipped when reading data rows. + * + * Generated from protobuf field int32 header_rows = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $header_rows = 0; + /** + * Optional. The delimiter that is used to separate values. The default is + * `,` (comma). + * + * Generated from protobuf field string delimiter = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $delimiter = ''; + /** + * Optional. The character encoding of the data. The default is UTF-8. + * + * Generated from protobuf field string encoding = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $encoding = ''; + /** + * Optional. Whether to disable the inference of data types for CSV data. + * If true, all columns are registered as strings. + * + * Generated from protobuf field bool type_inference_disabled = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $type_inference_disabled = false; + /** + * Optional. The character used to quote column values. Accepts `"` + * (double quotation mark) or `'` (single quotation mark). If unspecified, + * defaults to `"` (double quotation mark). + * + * Generated from protobuf field string quote = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $quote = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $header_rows + * Optional. The number of rows to interpret as header rows that should be + * skipped when reading data rows. + * @type string $delimiter + * Optional. The delimiter that is used to separate values. The default is + * `,` (comma). + * @type string $encoding + * Optional. The character encoding of the data. The default is UTF-8. + * @type bool $type_inference_disabled + * Optional. Whether to disable the inference of data types for CSV data. + * If true, all columns are registered as strings. + * @type string $quote + * Optional. The character used to quote column values. Accepts `"` + * (double quotation mark) or `'` (single quotation mark). If unspecified, + * defaults to `"` (double quotation mark). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\DataDiscovery::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The number of rows to interpret as header rows that should be + * skipped when reading data rows. + * + * Generated from protobuf field int32 header_rows = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getHeaderRows() + { + return $this->header_rows; + } + + /** + * Optional. The number of rows to interpret as header rows that should be + * skipped when reading data rows. + * + * Generated from protobuf field int32 header_rows = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setHeaderRows($var) + { + GPBUtil::checkInt32($var); + $this->header_rows = $var; + + return $this; + } + + /** + * Optional. The delimiter that is used to separate values. The default is + * `,` (comma). + * + * Generated from protobuf field string delimiter = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getDelimiter() + { + return $this->delimiter; + } + + /** + * Optional. The delimiter that is used to separate values. The default is + * `,` (comma). + * + * Generated from protobuf field string delimiter = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setDelimiter($var) + { + GPBUtil::checkString($var, True); + $this->delimiter = $var; + + return $this; + } + + /** + * Optional. The character encoding of the data. The default is UTF-8. + * + * Generated from protobuf field string encoding = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getEncoding() + { + return $this->encoding; + } + + /** + * Optional. The character encoding of the data. The default is UTF-8. + * + * Generated from protobuf field string encoding = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setEncoding($var) + { + GPBUtil::checkString($var, True); + $this->encoding = $var; + + return $this; + } + + /** + * Optional. Whether to disable the inference of data types for CSV data. + * If true, all columns are registered as strings. + * + * Generated from protobuf field bool type_inference_disabled = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getTypeInferenceDisabled() + { + return $this->type_inference_disabled; + } + + /** + * Optional. Whether to disable the inference of data types for CSV data. + * If true, all columns are registered as strings. + * + * Generated from protobuf field bool type_inference_disabled = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setTypeInferenceDisabled($var) + { + GPBUtil::checkBool($var); + $this->type_inference_disabled = $var; + + return $this; + } + + /** + * Optional. The character used to quote column values. Accepts `"` + * (double quotation mark) or `'` (single quotation mark). If unspecified, + * defaults to `"` (double quotation mark). + * + * Generated from protobuf field string quote = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getQuote() + { + return $this->quote; + } + + /** + * Optional. The character used to quote column values. Accepts `"` + * (double quotation mark) or `'` (single quotation mark). If unspecified, + * defaults to `"` (double quotation mark). + * + * Generated from protobuf field string quote = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setQuote($var) + { + GPBUtil::checkString($var, True); + $this->quote = $var; + + return $this; + } + +} + + diff --git a/Dataplex/src/V1/DataDiscoverySpec/StorageConfig/JsonOptions.php b/Dataplex/src/V1/DataDiscoverySpec/StorageConfig/JsonOptions.php new file mode 100644 index 000000000000..d5559c4bb018 --- /dev/null +++ b/Dataplex/src/V1/DataDiscoverySpec/StorageConfig/JsonOptions.php @@ -0,0 +1,110 @@ +google.cloud.dataplex.v1.DataDiscoverySpec.StorageConfig.JsonOptions + */ +class JsonOptions extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The character encoding of the data. The default is UTF-8. + * + * Generated from protobuf field string encoding = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $encoding = ''; + /** + * Optional. Whether to disable the inference of data types for JSON data. + * If true, all columns are registered as their primitive types + * (strings, number, or boolean). + * + * Generated from protobuf field bool type_inference_disabled = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $type_inference_disabled = false; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $encoding + * Optional. The character encoding of the data. The default is UTF-8. + * @type bool $type_inference_disabled + * Optional. Whether to disable the inference of data types for JSON data. + * If true, all columns are registered as their primitive types + * (strings, number, or boolean). + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\DataDiscovery::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The character encoding of the data. The default is UTF-8. + * + * Generated from protobuf field string encoding = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getEncoding() + { + return $this->encoding; + } + + /** + * Optional. The character encoding of the data. The default is UTF-8. + * + * Generated from protobuf field string encoding = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setEncoding($var) + { + GPBUtil::checkString($var, True); + $this->encoding = $var; + + return $this; + } + + /** + * Optional. Whether to disable the inference of data types for JSON data. + * If true, all columns are registered as their primitive types + * (strings, number, or boolean). + * + * Generated from protobuf field bool type_inference_disabled = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getTypeInferenceDisabled() + { + return $this->type_inference_disabled; + } + + /** + * Optional. Whether to disable the inference of data types for JSON data. + * If true, all columns are registered as their primitive types + * (strings, number, or boolean). + * + * Generated from protobuf field bool type_inference_disabled = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setTypeInferenceDisabled($var) + { + GPBUtil::checkBool($var); + $this->type_inference_disabled = $var; + + return $this; + } + +} + + diff --git a/Dataplex/src/V1/DataProfileResult/Profile/Field/ProfileInfo.php b/Dataplex/src/V1/DataProfileResult/Profile/Field/ProfileInfo.php index f3578fb41226..57ec1c2f523c 100644 --- a/Dataplex/src/V1/DataProfileResult/Profile/Field/ProfileInfo.php +++ b/Dataplex/src/V1/DataProfileResult/Profile/Field/ProfileInfo.php @@ -23,8 +23,8 @@ class ProfileInfo extends \Google\Protobuf\Internal\Message protected $null_ratio = 0.0; /** * Ratio of rows with distinct values against total scanned rows. - * Not available for complex non-groupable field type RECORD and fields - * with REPEATABLE mode. + * Not available for complex non-groupable field type, including RECORD, + * ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. * * Generated from protobuf field double distinct_ratio = 3; */ @@ -33,8 +33,8 @@ class ProfileInfo extends \Google\Protobuf\Internal\Message * The list of top N non-null values, frequency and ratio with which * they occur in the scanned data. N is 10 or equal to the number of * distinct values in the field, whichever is smaller. Not available for - * complex non-groupable field type RECORD and fields with REPEATABLE - * mode. + * complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, + * and JSON, as well as fields with REPEATABLE mode. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo.TopNValue top_n_values = 4; */ @@ -51,14 +51,14 @@ class ProfileInfo extends \Google\Protobuf\Internal\Message * Ratio of rows with null value against total scanned rows. * @type float $distinct_ratio * Ratio of rows with distinct values against total scanned rows. - * Not available for complex non-groupable field type RECORD and fields - * with REPEATABLE mode. + * Not available for complex non-groupable field type, including RECORD, + * ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. * @type array<\Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\TopNValue>|\Google\Protobuf\Internal\RepeatedField $top_n_values * The list of top N non-null values, frequency and ratio with which * they occur in the scanned data. N is 10 or equal to the number of * distinct values in the field, whichever is smaller. Not available for - * complex non-groupable field type RECORD and fields with REPEATABLE - * mode. + * complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, + * and JSON, as well as fields with REPEATABLE mode. * @type \Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\StringFieldInfo $string_profile * String type field information. * @type \Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\IntegerFieldInfo $integer_profile @@ -100,8 +100,8 @@ public function setNullRatio($var) /** * Ratio of rows with distinct values against total scanned rows. - * Not available for complex non-groupable field type RECORD and fields - * with REPEATABLE mode. + * Not available for complex non-groupable field type, including RECORD, + * ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. * * Generated from protobuf field double distinct_ratio = 3; * @return float @@ -113,8 +113,8 @@ public function getDistinctRatio() /** * Ratio of rows with distinct values against total scanned rows. - * Not available for complex non-groupable field type RECORD and fields - * with REPEATABLE mode. + * Not available for complex non-groupable field type, including RECORD, + * ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. * * Generated from protobuf field double distinct_ratio = 3; * @param float $var @@ -132,8 +132,8 @@ public function setDistinctRatio($var) * The list of top N non-null values, frequency and ratio with which * they occur in the scanned data. N is 10 or equal to the number of * distinct values in the field, whichever is smaller. Not available for - * complex non-groupable field type RECORD and fields with REPEATABLE - * mode. + * complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, + * and JSON, as well as fields with REPEATABLE mode. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo.TopNValue top_n_values = 4; * @return \Google\Protobuf\Internal\RepeatedField @@ -147,8 +147,8 @@ public function getTopNValues() * The list of top N non-null values, frequency and ratio with which * they occur in the scanned data. N is 10 or equal to the number of * distinct values in the field, whichever is smaller. Not available for - * complex non-groupable field type RECORD and fields with REPEATABLE - * mode. + * complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, + * and JSON, as well as fields with REPEATABLE mode. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo.TopNValue top_n_values = 4; * @param array<\Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\TopNValue>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Dataplex/src/V1/DataQualityDimension.php b/Dataplex/src/V1/DataQualityDimension.php index dbc14cbdc2de..36d78e08fdbe 100644 --- a/Dataplex/src/V1/DataQualityDimension.php +++ b/Dataplex/src/V1/DataQualityDimension.php @@ -19,7 +19,7 @@ class DataQualityDimension extends \Google\Protobuf\Internal\Message /** * The dimension name a rule belongs to. Supported dimensions are * ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", - * "INTEGRITY"] + * "FRESHNESS", "VOLUME"] * * Generated from protobuf field string name = 1; */ @@ -34,7 +34,7 @@ class DataQualityDimension extends \Google\Protobuf\Internal\Message * @type string $name * The dimension name a rule belongs to. Supported dimensions are * ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", - * "INTEGRITY"] + * "FRESHNESS", "VOLUME"] * } */ public function __construct($data = NULL) { @@ -45,7 +45,7 @@ public function __construct($data = NULL) { /** * The dimension name a rule belongs to. Supported dimensions are * ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", - * "INTEGRITY"] + * "FRESHNESS", "VOLUME"] * * Generated from protobuf field string name = 1; * @return string @@ -58,7 +58,7 @@ public function getName() /** * The dimension name a rule belongs to. Supported dimensions are * ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", - * "INTEGRITY"] + * "FRESHNESS", "VOLUME"] * * Generated from protobuf field string name = 1; * @param string $var diff --git a/Dataplex/src/V1/DataQualityRule.php b/Dataplex/src/V1/DataQualityRule.php index d473f813099a..92a98ff9269b 100644 --- a/Dataplex/src/V1/DataQualityRule.php +++ b/Dataplex/src/V1/DataQualityRule.php @@ -37,7 +37,8 @@ class DataQualityRule extends \Google\Protobuf\Internal\Message /** * Required. The dimension a rule belongs to. Results are also aggregated at * the dimension level. Supported dimensions are **["COMPLETENESS", - * "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]** + * "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", + * "VOLUME"]** * * Generated from protobuf field string dimension = 502 [(.google.api.field_behavior) = REQUIRED]; */ @@ -69,6 +70,13 @@ class DataQualityRule extends \Google\Protobuf\Internal\Message * Generated from protobuf field string description = 505 [(.google.api.field_behavior) = OPTIONAL]; */ protected $description = ''; + /** + * Optional. Whether the Rule is active or suspended. + * Default is false. + * + * Generated from protobuf field bool suspended = 506 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $suspended = false; protected $rule_type; /** @@ -116,7 +124,8 @@ class DataQualityRule extends \Google\Protobuf\Internal\Message * @type string $dimension * Required. The dimension a rule belongs to. Results are also aggregated at * the dimension level. Supported dimensions are **["COMPLETENESS", - * "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]** + * "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", + * "VOLUME"]** * @type float $threshold * Optional. The minimum ratio of **passing_rows / total_rows** required to * pass this rule, with a range of [0.0, 1.0]. @@ -132,6 +141,9 @@ class DataQualityRule extends \Google\Protobuf\Internal\Message * @type string $description * Optional. Description of the rule. * * The maximum length is 1,024 characters. + * @type bool $suspended + * Optional. Whether the Rule is active or suspended. + * Default is false. * } */ public function __construct($data = NULL) { @@ -501,7 +513,8 @@ public function setIgnoreNull($var) /** * Required. The dimension a rule belongs to. Results are also aggregated at * the dimension level. Supported dimensions are **["COMPLETENESS", - * "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]** + * "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", + * "VOLUME"]** * * Generated from protobuf field string dimension = 502 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -514,7 +527,8 @@ public function getDimension() /** * Required. The dimension a rule belongs to. Results are also aggregated at * the dimension level. Supported dimensions are **["COMPLETENESS", - * "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]** + * "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "FRESHNESS", + * "VOLUME"]** * * Generated from protobuf field string dimension = 502 [(.google.api.field_behavior) = REQUIRED]; * @param string $var @@ -624,6 +638,34 @@ public function setDescription($var) return $this; } + /** + * Optional. Whether the Rule is active or suspended. + * Default is false. + * + * Generated from protobuf field bool suspended = 506 [(.google.api.field_behavior) = OPTIONAL]; + * @return bool + */ + public function getSuspended() + { + return $this->suspended; + } + + /** + * Optional. Whether the Rule is active or suspended. + * Default is false. + * + * Generated from protobuf field bool suspended = 506 [(.google.api.field_behavior) = OPTIONAL]; + * @param bool $var + * @return $this + */ + public function setSuspended($var) + { + GPBUtil::checkBool($var); + $this->suspended = $var; + + return $this; + } + /** * @return string */ diff --git a/Dataplex/src/V1/DataScan.php b/Dataplex/src/V1/DataScan.php index 8f54f065081e..8564e293463c 100644 --- a/Dataplex/src/V1/DataScan.php +++ b/Dataplex/src/V1/DataScan.php @@ -142,13 +142,17 @@ class DataScan extends \Google\Protobuf\Internal\Message * @type int $type * Output only. The type of DataScan. * @type \Google\Cloud\Dataplex\V1\DataQualitySpec $data_quality_spec - * DataQualityScan related setting. + * Settings for a data quality scan. * @type \Google\Cloud\Dataplex\V1\DataProfileSpec $data_profile_spec - * DataProfileScan related setting. + * Settings for a data profile scan. + * @type \Google\Cloud\Dataplex\V1\DataDiscoverySpec $data_discovery_spec + * Settings for a data discovery scan. * @type \Google\Cloud\Dataplex\V1\DataQualityResult $data_quality_result - * Output only. The result of the data quality scan. + * Output only. The result of a data quality scan. * @type \Google\Cloud\Dataplex\V1\DataProfileResult $data_profile_result - * Output only. The result of the data profile scan. + * Output only. The result of a data profile scan. + * @type \Google\Cloud\Dataplex\V1\DataDiscoveryResult $data_discovery_result + * Output only. The result of a data discovery scan. * } */ public function __construct($data = NULL) { @@ -533,7 +537,7 @@ public function setType($var) } /** - * DataQualityScan related setting. + * Settings for a data quality scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100; * @return \Google\Cloud\Dataplex\V1\DataQualitySpec|null @@ -549,7 +553,7 @@ public function hasDataQualitySpec() } /** - * DataQualityScan related setting. + * Settings for a data quality scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100; * @param \Google\Cloud\Dataplex\V1\DataQualitySpec $var @@ -564,7 +568,7 @@ public function setDataQualitySpec($var) } /** - * DataProfileScan related setting. + * Settings for a data profile scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101; * @return \Google\Cloud\Dataplex\V1\DataProfileSpec|null @@ -580,7 +584,7 @@ public function hasDataProfileSpec() } /** - * DataProfileScan related setting. + * Settings for a data profile scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101; * @param \Google\Cloud\Dataplex\V1\DataProfileSpec $var @@ -595,7 +599,38 @@ public function setDataProfileSpec($var) } /** - * Output only. The result of the data quality scan. + * Settings for a data discovery scan. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec data_discovery_spec = 102; + * @return \Google\Cloud\Dataplex\V1\DataDiscoverySpec|null + */ + public function getDataDiscoverySpec() + { + return $this->readOneof(102); + } + + public function hasDataDiscoverySpec() + { + return $this->hasOneof(102); + } + + /** + * Settings for a data discovery scan. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec data_discovery_spec = 102; + * @param \Google\Cloud\Dataplex\V1\DataDiscoverySpec $var + * @return $this + */ + public function setDataDiscoverySpec($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\DataDiscoverySpec::class); + $this->writeOneof(102, $var); + + return $this; + } + + /** + * Output only. The result of a data quality scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Cloud\Dataplex\V1\DataQualityResult|null @@ -611,7 +646,7 @@ public function hasDataQualityResult() } /** - * Output only. The result of the data quality scan. + * Output only. The result of a data quality scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Cloud\Dataplex\V1\DataQualityResult $var @@ -626,7 +661,7 @@ public function setDataQualityResult($var) } /** - * Output only. The result of the data profile scan. + * Output only. The result of a data profile scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Cloud\Dataplex\V1\DataProfileResult|null @@ -642,7 +677,7 @@ public function hasDataProfileResult() } /** - * Output only. The result of the data profile scan. + * Output only. The result of a data profile scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Cloud\Dataplex\V1\DataProfileResult $var @@ -656,6 +691,37 @@ public function setDataProfileResult($var) return $this; } + /** + * Output only. The result of a data discovery scan. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoveryResult data_discovery_result = 202 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\Dataplex\V1\DataDiscoveryResult|null + */ + public function getDataDiscoveryResult() + { + return $this->readOneof(202); + } + + public function hasDataDiscoveryResult() + { + return $this->hasOneof(202); + } + + /** + * Output only. The result of a data discovery scan. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoveryResult data_discovery_result = 202 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\Dataplex\V1\DataDiscoveryResult $var + * @return $this + */ + public function setDataDiscoveryResult($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\DataDiscoveryResult::class); + $this->writeOneof(202, $var); + + return $this; + } + /** * @return string */ diff --git a/Dataplex/src/V1/DataScanEvent.php b/Dataplex/src/V1/DataScanEvent.php index d4263d16f7ac..2857c7cba9a2 100644 --- a/Dataplex/src/V1/DataScanEvent.php +++ b/Dataplex/src/V1/DataScanEvent.php @@ -11,7 +11,6 @@ /** * These messages contain information about the execution of a datascan. * The monitored resource is 'DataScan' - * Next ID: 13 * * Generated from protobuf message google.cloud.dataplex.v1.DataScanEvent */ diff --git a/Dataplex/src/V1/DataScanEvent/ScanType.php b/Dataplex/src/V1/DataScanEvent/ScanType.php index 48b48c2c9b6b..146c559113de 100644 --- a/Dataplex/src/V1/DataScanEvent/ScanType.php +++ b/Dataplex/src/V1/DataScanEvent/ScanType.php @@ -31,11 +31,18 @@ class ScanType * Generated from protobuf enum DATA_QUALITY = 2; */ const DATA_QUALITY = 2; + /** + * Data scan for data discovery. + * + * Generated from protobuf enum DATA_DISCOVERY = 4; + */ + const DATA_DISCOVERY = 4; private static $valueToName = [ self::SCAN_TYPE_UNSPECIFIED => 'SCAN_TYPE_UNSPECIFIED', self::DATA_PROFILE => 'DATA_PROFILE', self::DATA_QUALITY => 'DATA_QUALITY', + self::DATA_DISCOVERY => 'DATA_DISCOVERY', ]; public static function name($value) diff --git a/Dataplex/src/V1/DataScanJob.php b/Dataplex/src/V1/DataScanJob.php index c9d59028ed9e..4a02706e3001 100644 --- a/Dataplex/src/V1/DataScanJob.php +++ b/Dataplex/src/V1/DataScanJob.php @@ -30,6 +30,12 @@ class DataScanJob extends \Google\Protobuf\Internal\Message * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $uid = ''; + /** + * Output only. The time when the DataScanJob was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; /** * Output only. The time when the DataScanJob was started. * @@ -76,6 +82,8 @@ class DataScanJob extends \Google\Protobuf\Internal\Message * `location_id` refers to a GCP region. * @type string $uid * Output only. System generated globally unique ID for the DataScanJob. + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The time when the DataScanJob was created. * @type \Google\Protobuf\Timestamp $start_time * Output only. The time when the DataScanJob was started. * @type \Google\Protobuf\Timestamp $end_time @@ -87,13 +95,17 @@ class DataScanJob extends \Google\Protobuf\Internal\Message * @type int $type * Output only. The type of the parent DataScan. * @type \Google\Cloud\Dataplex\V1\DataQualitySpec $data_quality_spec - * Output only. DataQualityScan related setting. + * Output only. Settings for a data quality scan. * @type \Google\Cloud\Dataplex\V1\DataProfileSpec $data_profile_spec - * Output only. DataProfileScan related setting. + * Output only. Settings for a data profile scan. + * @type \Google\Cloud\Dataplex\V1\DataDiscoverySpec $data_discovery_spec + * Output only. Settings for a data discovery scan. * @type \Google\Cloud\Dataplex\V1\DataQualityResult $data_quality_result - * Output only. The result of the data quality scan. + * Output only. The result of a data quality scan. * @type \Google\Cloud\Dataplex\V1\DataProfileResult $data_profile_result - * Output only. The result of the data profile scan. + * Output only. The result of a data profile scan. + * @type \Google\Cloud\Dataplex\V1\DataDiscoveryResult $data_discovery_result + * Output only. The result of a data discovery scan. * } */ public function __construct($data = NULL) { @@ -159,6 +171,42 @@ public function setUid($var) return $this; } + /** + * Output only. The time when the DataScanJob was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The time when the DataScanJob was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + /** * Output only. The time when the DataScanJob was started. * @@ -310,7 +358,7 @@ public function setType($var) } /** - * Output only. DataQualityScan related setting. + * Output only. Settings for a data quality scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Cloud\Dataplex\V1\DataQualitySpec|null @@ -326,7 +374,7 @@ public function hasDataQualitySpec() } /** - * Output only. DataQualityScan related setting. + * Output only. Settings for a data quality scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Cloud\Dataplex\V1\DataQualitySpec $var @@ -341,7 +389,7 @@ public function setDataQualitySpec($var) } /** - * Output only. DataProfileScan related setting. + * Output only. Settings for a data profile scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Cloud\Dataplex\V1\DataProfileSpec|null @@ -357,7 +405,7 @@ public function hasDataProfileSpec() } /** - * Output only. DataProfileScan related setting. + * Output only. Settings for a data profile scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Cloud\Dataplex\V1\DataProfileSpec $var @@ -372,7 +420,38 @@ public function setDataProfileSpec($var) } /** - * Output only. The result of the data quality scan. + * Output only. Settings for a data discovery scan. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec data_discovery_spec = 102 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\Dataplex\V1\DataDiscoverySpec|null + */ + public function getDataDiscoverySpec() + { + return $this->readOneof(102); + } + + public function hasDataDiscoverySpec() + { + return $this->hasOneof(102); + } + + /** + * Output only. Settings for a data discovery scan. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoverySpec data_discovery_spec = 102 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\Dataplex\V1\DataDiscoverySpec $var + * @return $this + */ + public function setDataDiscoverySpec($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\DataDiscoverySpec::class); + $this->writeOneof(102, $var); + + return $this; + } + + /** + * Output only. The result of a data quality scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Cloud\Dataplex\V1\DataQualityResult|null @@ -388,7 +467,7 @@ public function hasDataQualityResult() } /** - * Output only. The result of the data quality scan. + * Output only. The result of a data quality scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Cloud\Dataplex\V1\DataQualityResult $var @@ -403,7 +482,7 @@ public function setDataQualityResult($var) } /** - * Output only. The result of the data profile scan. + * Output only. The result of a data profile scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Cloud\Dataplex\V1\DataProfileResult|null @@ -419,7 +498,7 @@ public function hasDataProfileResult() } /** - * Output only. The result of the data profile scan. + * Output only. The result of a data profile scan. * * Generated from protobuf field .google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Cloud\Dataplex\V1\DataProfileResult $var @@ -433,6 +512,37 @@ public function setDataProfileResult($var) return $this; } + /** + * Output only. The result of a data discovery scan. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoveryResult data_discovery_result = 202 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\Dataplex\V1\DataDiscoveryResult|null + */ + public function getDataDiscoveryResult() + { + return $this->readOneof(202); + } + + public function hasDataDiscoveryResult() + { + return $this->hasOneof(202); + } + + /** + * Output only. The result of a data discovery scan. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DataDiscoveryResult data_discovery_result = 202 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\Dataplex\V1\DataDiscoveryResult $var + * @return $this + */ + public function setDataDiscoveryResult($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\DataDiscoveryResult::class); + $this->writeOneof(202, $var); + + return $this; + } + /** * @return string */ diff --git a/Dataplex/src/V1/DataScanType.php b/Dataplex/src/V1/DataScanType.php index 66a3a372f908..f46e8c039a80 100644 --- a/Dataplex/src/V1/DataScanType.php +++ b/Dataplex/src/V1/DataScanType.php @@ -7,35 +7,42 @@ use UnexpectedValueException; /** - * The type of DataScan. + * The type of data scan. * * Protobuf type google.cloud.dataplex.v1.DataScanType */ class DataScanType { /** - * The DataScan type is unspecified. + * The data scan type is unspecified. * * Generated from protobuf enum DATA_SCAN_TYPE_UNSPECIFIED = 0; */ const DATA_SCAN_TYPE_UNSPECIFIED = 0; /** - * Data Quality scan. + * Data quality scan. * * Generated from protobuf enum DATA_QUALITY = 1; */ const DATA_QUALITY = 1; /** - * Data Profile scan. + * Data profile scan. * * Generated from protobuf enum DATA_PROFILE = 2; */ const DATA_PROFILE = 2; + /** + * Data discovery scan. + * + * Generated from protobuf enum DATA_DISCOVERY = 3; + */ + const DATA_DISCOVERY = 3; private static $valueToName = [ self::DATA_SCAN_TYPE_UNSPECIFIED => 'DATA_SCAN_TYPE_UNSPECIFIED', self::DATA_QUALITY => 'DATA_QUALITY', self::DATA_PROFILE => 'DATA_PROFILE', + self::DATA_DISCOVERY => 'DATA_DISCOVERY', ]; public static function name($value) diff --git a/Dataplex/src/V1/DeleteAspectTypeRequest.php b/Dataplex/src/V1/DeleteAspectTypeRequest.php index c4a2135e2ac5..60c49b306fce 100644 --- a/Dataplex/src/V1/DeleteAspectTypeRequest.php +++ b/Dataplex/src/V1/DeleteAspectTypeRequest.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Delele AspectType Request + * Delele AspectType Request. * * Generated from protobuf message google.cloud.dataplex.v1.DeleteAspectTypeRequest */ @@ -24,7 +24,8 @@ class DeleteAspectTypeRequest extends \Google\Protobuf\Internal\Message protected $name = ''; /** * Optional. If the client provided etag value does not match the current etag - * value, the DeleteAspectTypeRequest method returns an ABORTED error response + * value, the DeleteAspectTypeRequest method returns an ABORTED error + * response. * * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -56,7 +57,8 @@ public static function build(string $name): self * `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`. * @type string $etag * Optional. If the client provided etag value does not match the current etag - * value, the DeleteAspectTypeRequest method returns an ABORTED error response + * value, the DeleteAspectTypeRequest method returns an ABORTED error + * response. * } */ public function __construct($data = NULL) { @@ -94,7 +96,8 @@ public function setName($var) /** * Optional. If the client provided etag value does not match the current etag - * value, the DeleteAspectTypeRequest method returns an ABORTED error response + * value, the DeleteAspectTypeRequest method returns an ABORTED error + * response. * * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -106,7 +109,8 @@ public function getEtag() /** * Optional. If the client provided etag value does not match the current etag - * value, the DeleteAspectTypeRequest method returns an ABORTED error response + * value, the DeleteAspectTypeRequest method returns an ABORTED error + * response. * * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/Dataplex/src/V1/DeleteEntryGroupRequest.php b/Dataplex/src/V1/DeleteEntryGroupRequest.php index 00b6cc153273..70d5513d841e 100644 --- a/Dataplex/src/V1/DeleteEntryGroupRequest.php +++ b/Dataplex/src/V1/DeleteEntryGroupRequest.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Delele EntryGroup Request + * Delete EntryGroup Request. * * Generated from protobuf message google.cloud.dataplex.v1.DeleteEntryGroupRequest */ @@ -24,7 +24,8 @@ class DeleteEntryGroupRequest extends \Google\Protobuf\Internal\Message protected $name = ''; /** * Optional. If the client provided etag value does not match the current etag - * value, the DeleteEntryGroupRequest method returns an ABORTED error response + * value, the DeleteEntryGroupRequest method returns an ABORTED error + * response. * * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -56,7 +57,8 @@ public static function build(string $name): self * `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`. * @type string $etag * Optional. If the client provided etag value does not match the current etag - * value, the DeleteEntryGroupRequest method returns an ABORTED error response + * value, the DeleteEntryGroupRequest method returns an ABORTED error + * response. * } */ public function __construct($data = NULL) { @@ -94,7 +96,8 @@ public function setName($var) /** * Optional. If the client provided etag value does not match the current etag - * value, the DeleteEntryGroupRequest method returns an ABORTED error response + * value, the DeleteEntryGroupRequest method returns an ABORTED error + * response. * * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -106,7 +109,8 @@ public function getEtag() /** * Optional. If the client provided etag value does not match the current etag - * value, the DeleteEntryGroupRequest method returns an ABORTED error response + * value, the DeleteEntryGroupRequest method returns an ABORTED error + * response. * * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/Dataplex/src/V1/DeleteEntryRequest.php b/Dataplex/src/V1/DeleteEntryRequest.php index 5ad5bed0d9f4..8ce9cf9dec16 100644 --- a/Dataplex/src/V1/DeleteEntryRequest.php +++ b/Dataplex/src/V1/DeleteEntryRequest.php @@ -9,6 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** + * Delete Entry request. + * * Generated from protobuf message google.cloud.dataplex.v1.DeleteEntryRequest */ class DeleteEntryRequest extends \Google\Protobuf\Internal\Message diff --git a/Dataplex/src/V1/DeleteEntryTypeRequest.php b/Dataplex/src/V1/DeleteEntryTypeRequest.php index 5e44ac6568ba..075317212625 100644 --- a/Dataplex/src/V1/DeleteEntryTypeRequest.php +++ b/Dataplex/src/V1/DeleteEntryTypeRequest.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Delele EntryType Request + * Delele EntryType Request. * * Generated from protobuf message google.cloud.dataplex.v1.DeleteEntryTypeRequest */ @@ -24,7 +24,7 @@ class DeleteEntryTypeRequest extends \Google\Protobuf\Internal\Message protected $name = ''; /** * Optional. If the client provided etag value does not match the current etag - * value, the DeleteEntryTypeRequest method returns an ABORTED error response + * value, the DeleteEntryTypeRequest method returns an ABORTED error response. * * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -56,7 +56,7 @@ public static function build(string $name): self * `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`. * @type string $etag * Optional. If the client provided etag value does not match the current etag - * value, the DeleteEntryTypeRequest method returns an ABORTED error response + * value, the DeleteEntryTypeRequest method returns an ABORTED error response. * } */ public function __construct($data = NULL) { @@ -94,7 +94,7 @@ public function setName($var) /** * Optional. If the client provided etag value does not match the current etag - * value, the DeleteEntryTypeRequest method returns an ABORTED error response + * value, the DeleteEntryTypeRequest method returns an ABORTED error response. * * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -106,7 +106,7 @@ public function getEtag() /** * Optional. If the client provided etag value does not match the current etag - * value, the DeleteEntryTypeRequest method returns an ABORTED error response + * value, the DeleteEntryTypeRequest method returns an ABORTED error response. * * Generated from protobuf field string etag = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/Dataplex/src/V1/DiscoveryEvent.php b/Dataplex/src/V1/DiscoveryEvent.php index c72a91aa4b02..0a3a6c09eb6d 100644 --- a/Dataplex/src/V1/DiscoveryEvent.php +++ b/Dataplex/src/V1/DiscoveryEvent.php @@ -45,6 +45,12 @@ class DiscoveryEvent extends \Google\Protobuf\Internal\Message * Generated from protobuf field string data_location = 5; */ protected $data_location = ''; + /** + * The id of the associated datascan for standalone discovery. + * + * Generated from protobuf field string datascan_id = 6; + */ + protected $datascan_id = ''; /** * The type of the event being logged. * @@ -69,6 +75,8 @@ class DiscoveryEvent extends \Google\Protobuf\Internal\Message * The id of the associated asset. * @type string $data_location * The data location associated with the event. + * @type string $datascan_id + * The id of the associated datascan for standalone discovery. * @type int $type * The type of the event being logged. * @type \Google\Cloud\Dataplex\V1\DiscoveryEvent\ConfigDetails $config @@ -79,6 +87,8 @@ class DiscoveryEvent extends \Google\Protobuf\Internal\Message * Details about the partition associated with the event. * @type \Google\Cloud\Dataplex\V1\DiscoveryEvent\ActionDetails $action * Details about the action associated with the event. + * @type \Google\Cloud\Dataplex\V1\DiscoveryEvent\TableDetails $table + * Details about the BigQuery table publishing associated with the event. * } */ public function __construct($data = NULL) { @@ -216,6 +226,32 @@ public function setDataLocation($var) return $this; } + /** + * The id of the associated datascan for standalone discovery. + * + * Generated from protobuf field string datascan_id = 6; + * @return string + */ + public function getDatascanId() + { + return $this->datascan_id; + } + + /** + * The id of the associated datascan for standalone discovery. + * + * Generated from protobuf field string datascan_id = 6; + * @param string $var + * @return $this + */ + public function setDatascanId($var) + { + GPBUtil::checkString($var, True); + $this->datascan_id = $var; + + return $this; + } + /** * The type of the event being logged. * @@ -366,6 +402,37 @@ public function setAction($var) return $this; } + /** + * Details about the BigQuery table publishing associated with the event. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DiscoveryEvent.TableDetails table = 24; + * @return \Google\Cloud\Dataplex\V1\DiscoveryEvent\TableDetails|null + */ + public function getTable() + { + return $this->readOneof(24); + } + + public function hasTable() + { + return $this->hasOneof(24); + } + + /** + * Details about the BigQuery table publishing associated with the event. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DiscoveryEvent.TableDetails table = 24; + * @param \Google\Cloud\Dataplex\V1\DiscoveryEvent\TableDetails $var + * @return $this + */ + public function setTable($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\DiscoveryEvent\TableDetails::class); + $this->writeOneof(24, $var); + + return $this; + } + /** * @return string */ diff --git a/Dataplex/src/V1/DiscoveryEvent/ActionDetails.php b/Dataplex/src/V1/DiscoveryEvent/ActionDetails.php index 7ed35c18f327..37ad9cef303a 100644 --- a/Dataplex/src/V1/DiscoveryEvent/ActionDetails.php +++ b/Dataplex/src/V1/DiscoveryEvent/ActionDetails.php @@ -22,6 +22,12 @@ class ActionDetails extends \Google\Protobuf\Internal\Message * Generated from protobuf field string type = 1; */ protected $type = ''; + /** + * The human readable issue associated with the action. + * + * Generated from protobuf field string issue = 2; + */ + protected $issue = ''; /** * Constructor. @@ -32,6 +38,8 @@ class ActionDetails extends \Google\Protobuf\Internal\Message * @type string $type * The type of action. * Eg. IncompatibleDataSchema, InvalidDataFormat + * @type string $issue + * The human readable issue associated with the action. * } */ public function __construct($data = NULL) { @@ -67,6 +75,32 @@ public function setType($var) return $this; } + /** + * The human readable issue associated with the action. + * + * Generated from protobuf field string issue = 2; + * @return string + */ + public function getIssue() + { + return $this->issue; + } + + /** + * The human readable issue associated with the action. + * + * Generated from protobuf field string issue = 2; + * @param string $var + * @return $this + */ + public function setIssue($var) + { + GPBUtil::checkString($var, True); + $this->issue = $var; + + return $this; + } + } diff --git a/Dataplex/src/V1/DiscoveryEvent/EventType.php b/Dataplex/src/V1/DiscoveryEvent/EventType.php index ce28fff6c7c6..c1d56a9ecfec 100644 --- a/Dataplex/src/V1/DiscoveryEvent/EventType.php +++ b/Dataplex/src/V1/DiscoveryEvent/EventType.php @@ -61,6 +61,30 @@ class EventType * Generated from protobuf enum PARTITION_DELETED = 7; */ const PARTITION_DELETED = 7; + /** + * An event representing a table being published. + * + * Generated from protobuf enum TABLE_PUBLISHED = 10; + */ + const TABLE_PUBLISHED = 10; + /** + * An event representing a table being updated. + * + * Generated from protobuf enum TABLE_UPDATED = 11; + */ + const TABLE_UPDATED = 11; + /** + * An event representing a table being skipped in publishing. + * + * Generated from protobuf enum TABLE_IGNORED = 12; + */ + const TABLE_IGNORED = 12; + /** + * An event representing a table being deleted. + * + * Generated from protobuf enum TABLE_DELETED = 13; + */ + const TABLE_DELETED = 13; private static $valueToName = [ self::EVENT_TYPE_UNSPECIFIED => 'EVENT_TYPE_UNSPECIFIED', @@ -71,6 +95,10 @@ class EventType self::PARTITION_CREATED => 'PARTITION_CREATED', self::PARTITION_UPDATED => 'PARTITION_UPDATED', self::PARTITION_DELETED => 'PARTITION_DELETED', + self::TABLE_PUBLISHED => 'TABLE_PUBLISHED', + self::TABLE_UPDATED => 'TABLE_UPDATED', + self::TABLE_IGNORED => 'TABLE_IGNORED', + self::TABLE_DELETED => 'TABLE_DELETED', ]; public static function name($value) diff --git a/Dataplex/src/V1/DiscoveryEvent/TableDetails.php b/Dataplex/src/V1/DiscoveryEvent/TableDetails.php new file mode 100644 index 000000000000..6cda45bbcb8e --- /dev/null +++ b/Dataplex/src/V1/DiscoveryEvent/TableDetails.php @@ -0,0 +1,102 @@ +google.cloud.dataplex.v1.DiscoveryEvent.TableDetails + */ +class TableDetails extends \Google\Protobuf\Internal\Message +{ + /** + * The fully-qualified resource name of the table resource. + * + * Generated from protobuf field string table = 1; + */ + protected $table = ''; + /** + * The type of the table resource. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DiscoveryEvent.TableType type = 2; + */ + protected $type = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $table + * The fully-qualified resource name of the table resource. + * @type int $type + * The type of the table resource. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\Logs::initOnce(); + parent::__construct($data); + } + + /** + * The fully-qualified resource name of the table resource. + * + * Generated from protobuf field string table = 1; + * @return string + */ + public function getTable() + { + return $this->table; + } + + /** + * The fully-qualified resource name of the table resource. + * + * Generated from protobuf field string table = 1; + * @param string $var + * @return $this + */ + public function setTable($var) + { + GPBUtil::checkString($var, True); + $this->table = $var; + + return $this; + } + + /** + * The type of the table resource. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DiscoveryEvent.TableType type = 2; + * @return int + */ + public function getType() + { + return $this->type; + } + + /** + * The type of the table resource. + * + * Generated from protobuf field .google.cloud.dataplex.v1.DiscoveryEvent.TableType type = 2; + * @param int $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Dataplex\V1\DiscoveryEvent\TableType::class); + $this->type = $var; + + return $this; + } + +} + + diff --git a/Dataplex/src/V1/DiscoveryEvent/TableType.php b/Dataplex/src/V1/DiscoveryEvent/TableType.php new file mode 100644 index 000000000000..3b5856650cd1 --- /dev/null +++ b/Dataplex/src/V1/DiscoveryEvent/TableType.php @@ -0,0 +1,69 @@ +google.cloud.dataplex.v1.DiscoveryEvent.TableType + */ +class TableType +{ + /** + * An unspecified table type. + * + * Generated from protobuf enum TABLE_TYPE_UNSPECIFIED = 0; + */ + const TABLE_TYPE_UNSPECIFIED = 0; + /** + * External table type. + * + * Generated from protobuf enum EXTERNAL_TABLE = 1; + */ + const EXTERNAL_TABLE = 1; + /** + * BigLake table type. + * + * Generated from protobuf enum BIGLAKE_TABLE = 2; + */ + const BIGLAKE_TABLE = 2; + /** + * Object table type for unstructured data. + * + * Generated from protobuf enum OBJECT_TABLE = 3; + */ + const OBJECT_TABLE = 3; + + private static $valueToName = [ + self::TABLE_TYPE_UNSPECIFIED => 'TABLE_TYPE_UNSPECIFIED', + self::EXTERNAL_TABLE => 'EXTERNAL_TABLE', + self::BIGLAKE_TABLE => 'BIGLAKE_TABLE', + self::OBJECT_TABLE => 'OBJECT_TABLE', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Dataplex/src/V1/Entry.php b/Dataplex/src/V1/Entry.php index dca2b1ddd162..ed5025b7b2f5 100644 --- a/Dataplex/src/V1/Entry.php +++ b/Dataplex/src/V1/Entry.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * An entry is a representation of a data asset which can be described by + * An entry is a representation of a data resource that can be described by * various metadata. * * Generated from protobuf message google.cloud.dataplex.v1.Entry @@ -17,38 +17,40 @@ class Entry extends \Google\Protobuf\Internal\Message { /** - * Identifier. The relative resource name of the Entry, of the form: - * projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + * Identifier. The relative resource name of the entry, in the format + * `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; */ protected $name = ''; /** - * Required. Immutable. The resource name of the EntryType used to create this - * Entry. + * Required. Immutable. The relative resource name of the entry type that was + * used to create this entry, in the format + * `projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}`. * * Generated from protobuf field string entry_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE]; */ protected $entry_type = ''; /** - * Output only. The time when the Entry was created. + * Output only. The time when the entry was created in Dataplex. * * Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $create_time = null; /** - * Output only. The time when the Entry was last updated. + * Output only. The time when the entry was last updated in Dataplex. * * Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $update_time = null; /** - * Optional. The Aspects attached to the Entry. - * The format for the key can be one of the following: - * 1. {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached - * directly to the entry) - * 2. {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is - * attached to an entry's path) + * Optional. The aspects that are attached to the entry. Depending on how the + * aspect is attached to the entry, the format of the aspect key can be one of + * the following: + * * If the aspect is attached directly to the entry: + * `{project_id_or_number}.{location_id}.{aspect_type_id}` + * * If the aspect is attached to an entry's path: + * `{project_id_or_number}.{location_id}.{aspect_type_id}@{path}` * * Generated from protobuf field map aspects = 9 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -60,14 +62,17 @@ class Entry extends \Google\Protobuf\Internal\Message */ protected $parent_entry = ''; /** - * Optional. A name for the entry that can reference it in an external system. + * Optional. A name for the entry that can be referenced by an external + * system. For more information, see [Fully qualified + * names](https://cloud.google.com/data-catalog/docs/fully-qualified-names). * The maximum size of the field is 4000 characters. * * Generated from protobuf field string fully_qualified_name = 12 [(.google.api.field_behavior) = OPTIONAL]; */ protected $fully_qualified_name = ''; /** - * Optional. Source system related information for an entry. + * Optional. Information related to the source system of the data resource + * that is represented by the entry. * * Generated from protobuf field .google.cloud.dataplex.v1.EntrySource entry_source = 15 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -80,29 +85,34 @@ class Entry extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Identifier. The relative resource name of the Entry, of the form: - * projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + * Identifier. The relative resource name of the entry, in the format + * `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}`. * @type string $entry_type - * Required. Immutable. The resource name of the EntryType used to create this - * Entry. + * Required. Immutable. The relative resource name of the entry type that was + * used to create this entry, in the format + * `projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}`. * @type \Google\Protobuf\Timestamp $create_time - * Output only. The time when the Entry was created. + * Output only. The time when the entry was created in Dataplex. * @type \Google\Protobuf\Timestamp $update_time - * Output only. The time when the Entry was last updated. + * Output only. The time when the entry was last updated in Dataplex. * @type array|\Google\Protobuf\Internal\MapField $aspects - * Optional. The Aspects attached to the Entry. - * The format for the key can be one of the following: - * 1. {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached - * directly to the entry) - * 2. {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is - * attached to an entry's path) + * Optional. The aspects that are attached to the entry. Depending on how the + * aspect is attached to the entry, the format of the aspect key can be one of + * the following: + * * If the aspect is attached directly to the entry: + * `{project_id_or_number}.{location_id}.{aspect_type_id}` + * * If the aspect is attached to an entry's path: + * `{project_id_or_number}.{location_id}.{aspect_type_id}@{path}` * @type string $parent_entry * Optional. Immutable. The resource name of the parent entry. * @type string $fully_qualified_name - * Optional. A name for the entry that can reference it in an external system. + * Optional. A name for the entry that can be referenced by an external + * system. For more information, see [Fully qualified + * names](https://cloud.google.com/data-catalog/docs/fully-qualified-names). * The maximum size of the field is 4000 characters. * @type \Google\Cloud\Dataplex\V1\EntrySource $entry_source - * Optional. Source system related information for an entry. + * Optional. Information related to the source system of the data resource + * that is represented by the entry. * } */ public function __construct($data = NULL) { @@ -111,8 +121,8 @@ public function __construct($data = NULL) { } /** - * Identifier. The relative resource name of the Entry, of the form: - * projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + * Identifier. The relative resource name of the entry, in the format + * `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @return string @@ -123,8 +133,8 @@ public function getName() } /** - * Identifier. The relative resource name of the Entry, of the form: - * projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + * Identifier. The relative resource name of the entry, in the format + * `projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER]; * @param string $var @@ -139,8 +149,9 @@ public function setName($var) } /** - * Required. Immutable. The resource name of the EntryType used to create this - * Entry. + * Required. Immutable. The relative resource name of the entry type that was + * used to create this entry, in the format + * `projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}`. * * Generated from protobuf field string entry_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE]; * @return string @@ -151,8 +162,9 @@ public function getEntryType() } /** - * Required. Immutable. The resource name of the EntryType used to create this - * Entry. + * Required. Immutable. The relative resource name of the entry type that was + * used to create this entry, in the format + * `projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}`. * * Generated from protobuf field string entry_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE]; * @param string $var @@ -167,7 +179,7 @@ public function setEntryType($var) } /** - * Output only. The time when the Entry was created. + * Output only. The time when the entry was created in Dataplex. * * Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Protobuf\Timestamp|null @@ -188,7 +200,7 @@ public function clearCreateTime() } /** - * Output only. The time when the Entry was created. + * Output only. The time when the entry was created in Dataplex. * * Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Protobuf\Timestamp $var @@ -203,7 +215,7 @@ public function setCreateTime($var) } /** - * Output only. The time when the Entry was last updated. + * Output only. The time when the entry was last updated in Dataplex. * * Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Protobuf\Timestamp|null @@ -224,7 +236,7 @@ public function clearUpdateTime() } /** - * Output only. The time when the Entry was last updated. + * Output only. The time when the entry was last updated in Dataplex. * * Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param \Google\Protobuf\Timestamp $var @@ -239,12 +251,13 @@ public function setUpdateTime($var) } /** - * Optional. The Aspects attached to the Entry. - * The format for the key can be one of the following: - * 1. {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached - * directly to the entry) - * 2. {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is - * attached to an entry's path) + * Optional. The aspects that are attached to the entry. Depending on how the + * aspect is attached to the entry, the format of the aspect key can be one of + * the following: + * * If the aspect is attached directly to the entry: + * `{project_id_or_number}.{location_id}.{aspect_type_id}` + * * If the aspect is attached to an entry's path: + * `{project_id_or_number}.{location_id}.{aspect_type_id}@{path}` * * Generated from protobuf field map aspects = 9 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\MapField @@ -255,12 +268,13 @@ public function getAspects() } /** - * Optional. The Aspects attached to the Entry. - * The format for the key can be one of the following: - * 1. {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached - * directly to the entry) - * 2. {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is - * attached to an entry's path) + * Optional. The aspects that are attached to the entry. Depending on how the + * aspect is attached to the entry, the format of the aspect key can be one of + * the following: + * * If the aspect is attached directly to the entry: + * `{project_id_or_number}.{location_id}.{aspect_type_id}` + * * If the aspect is attached to an entry's path: + * `{project_id_or_number}.{location_id}.{aspect_type_id}@{path}` * * Generated from protobuf field map aspects = 9 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\MapField $var @@ -301,7 +315,9 @@ public function setParentEntry($var) } /** - * Optional. A name for the entry that can reference it in an external system. + * Optional. A name for the entry that can be referenced by an external + * system. For more information, see [Fully qualified + * names](https://cloud.google.com/data-catalog/docs/fully-qualified-names). * The maximum size of the field is 4000 characters. * * Generated from protobuf field string fully_qualified_name = 12 [(.google.api.field_behavior) = OPTIONAL]; @@ -313,7 +329,9 @@ public function getFullyQualifiedName() } /** - * Optional. A name for the entry that can reference it in an external system. + * Optional. A name for the entry that can be referenced by an external + * system. For more information, see [Fully qualified + * names](https://cloud.google.com/data-catalog/docs/fully-qualified-names). * The maximum size of the field is 4000 characters. * * Generated from protobuf field string fully_qualified_name = 12 [(.google.api.field_behavior) = OPTIONAL]; @@ -329,7 +347,8 @@ public function setFullyQualifiedName($var) } /** - * Optional. Source system related information for an entry. + * Optional. Information related to the source system of the data resource + * that is represented by the entry. * * Generated from protobuf field .google.cloud.dataplex.v1.EntrySource entry_source = 15 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Cloud\Dataplex\V1\EntrySource|null @@ -350,7 +369,8 @@ public function clearEntrySource() } /** - * Optional. Source system related information for an entry. + * Optional. Information related to the source system of the data resource + * that is represented by the entry. * * Generated from protobuf field .google.cloud.dataplex.v1.EntrySource entry_source = 15 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Cloud\Dataplex\V1\EntrySource $var diff --git a/Dataplex/src/V1/EntryGroup.php b/Dataplex/src/V1/EntryGroup.php index 58bc94c0a32a..279c283927f8 100644 --- a/Dataplex/src/V1/EntryGroup.php +++ b/Dataplex/src/V1/EntryGroup.php @@ -16,16 +16,16 @@ class EntryGroup extends \Google\Protobuf\Internal\Message { /** - * Output only. The relative resource name of the EntryGroup, of the form: - * projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. + * Output only. The relative resource name of the EntryGroup, in the format + * projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { */ protected $name = ''; /** - * Output only. System generated globally unique ID for the EntryGroup. This - * ID will be different if the EntryGroup is deleted and re-created with the - * same name. + * Output only. System generated globally unique ID for the EntryGroup. If you + * delete and recreate the EntryGroup with the same name, this ID will be + * different. * * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -61,9 +61,9 @@ class EntryGroup extends \Google\Protobuf\Internal\Message */ private $labels; /** - * This checksum is computed by the server based on the value of other - * fields, and may be sent on update and delete requests to ensure the - * client has an up-to-date value before proceeding. + * This checksum is computed by the service, and might be sent on update and + * delete requests to ensure the client has an up-to-date value before + * proceeding. * * Generated from protobuf field string etag = 8; */ @@ -83,12 +83,12 @@ class EntryGroup extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type string $name - * Output only. The relative resource name of the EntryGroup, of the form: - * projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. + * Output only. The relative resource name of the EntryGroup, in the format + * projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. * @type string $uid - * Output only. System generated globally unique ID for the EntryGroup. This - * ID will be different if the EntryGroup is deleted and re-created with the - * same name. + * Output only. System generated globally unique ID for the EntryGroup. If you + * delete and recreate the EntryGroup with the same name, this ID will be + * different. * @type \Google\Protobuf\Timestamp $create_time * Output only. The time when the EntryGroup was created. * @type \Google\Protobuf\Timestamp $update_time @@ -100,9 +100,9 @@ class EntryGroup extends \Google\Protobuf\Internal\Message * @type array|\Google\Protobuf\Internal\MapField $labels * Optional. User-defined labels for the EntryGroup. * @type string $etag - * This checksum is computed by the server based on the value of other - * fields, and may be sent on update and delete requests to ensure the - * client has an up-to-date value before proceeding. + * This checksum is computed by the service, and might be sent on update and + * delete requests to ensure the client has an up-to-date value before + * proceeding. * @type int $transfer_status * Output only. Denotes the transfer status of the Entry Group. It is * unspecified for Entry Group created from Dataplex API. @@ -114,8 +114,8 @@ public function __construct($data = NULL) { } /** - * Output only. The relative resource name of the EntryGroup, of the form: - * projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. + * Output only. The relative resource name of the EntryGroup, in the format + * projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { * @return string @@ -126,8 +126,8 @@ public function getName() } /** - * Output only. The relative resource name of the EntryGroup, of the form: - * projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. + * Output only. The relative resource name of the EntryGroup, in the format + * projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { * @param string $var @@ -142,9 +142,9 @@ public function setName($var) } /** - * Output only. System generated globally unique ID for the EntryGroup. This - * ID will be different if the EntryGroup is deleted and re-created with the - * same name. + * Output only. System generated globally unique ID for the EntryGroup. If you + * delete and recreate the EntryGroup with the same name, this ID will be + * different. * * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string @@ -155,9 +155,9 @@ public function getUid() } /** - * Output only. System generated globally unique ID for the EntryGroup. This - * ID will be different if the EntryGroup is deleted and re-created with the - * same name. + * Output only. System generated globally unique ID for the EntryGroup. If you + * delete and recreate the EntryGroup with the same name, this ID will be + * different. * * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var @@ -322,9 +322,9 @@ public function setLabels($var) } /** - * This checksum is computed by the server based on the value of other - * fields, and may be sent on update and delete requests to ensure the - * client has an up-to-date value before proceeding. + * This checksum is computed by the service, and might be sent on update and + * delete requests to ensure the client has an up-to-date value before + * proceeding. * * Generated from protobuf field string etag = 8; * @return string @@ -335,9 +335,9 @@ public function getEtag() } /** - * This checksum is computed by the server based on the value of other - * fields, and may be sent on update and delete requests to ensure the - * client has an up-to-date value before proceeding. + * This checksum is computed by the service, and might be sent on update and + * delete requests to ensure the client has an up-to-date value before + * proceeding. * * Generated from protobuf field string etag = 8; * @param string $var diff --git a/Dataplex/src/V1/EntrySource.php b/Dataplex/src/V1/EntrySource.php index 9ad43ede8e01..fe41684ee4fe 100644 --- a/Dataplex/src/V1/EntrySource.php +++ b/Dataplex/src/V1/EntrySource.php @@ -9,8 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * EntrySource contains source system related information for the - * entry. + * Information related to the source system of the data resource that is + * represented by the entry. * * Generated from protobuf message google.cloud.dataplex.v1.EntrySource */ @@ -18,35 +18,35 @@ class EntrySource extends \Google\Protobuf\Internal\Message { /** * The name of the resource in the source system. - * The maximum size of the field is 4000 characters. + * Maximum length is 4,000 characters. * * Generated from protobuf field string resource = 1; */ protected $resource = ''; /** * The name of the source system. - * The maximum size of the field is 64 characters. + * Maximum length is 64 characters. * * Generated from protobuf field string system = 2; */ protected $system = ''; /** * The platform containing the source system. - * The maximum size of the field is 64 characters. + * Maximum length is 64 characters. * * Generated from protobuf field string platform = 3; */ protected $platform = ''; /** - * User friendly display name. - * The maximum size of the field is 500 characters. + * A user-friendly display name. + * Maximum length is 500 characters. * * Generated from protobuf field string display_name = 5; */ protected $display_name = ''; /** - * Description of the Entry. - * The maximum size of the field is 2000 characters. + * A description of the data resource. + * Maximum length is 2,000 characters. * * Generated from protobuf field string description = 6; */ @@ -59,28 +59,32 @@ class EntrySource extends \Google\Protobuf\Internal\Message */ private $labels; /** - * Immutable. The ancestors of the Entry in the source system. + * Immutable. The entries representing the ancestors of the data resource in + * the source system. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.EntrySource.Ancestor ancestors = 9 [(.google.api.field_behavior) = IMMUTABLE]; */ private $ancestors; /** - * The create time of the resource in the source system. + * The time when the resource was created in the source system. * * Generated from protobuf field .google.protobuf.Timestamp create_time = 10; */ protected $create_time = null; /** - * The update time of the resource in the source system. + * The time when the resource was last updated in the source system. If the + * entry exists in the system and its `EntrySource` has `update_time` + * populated, further updates to the `EntrySource` of the entry must provide + * incremental updates to its `update_time`. * * Generated from protobuf field .google.protobuf.Timestamp update_time = 11; */ protected $update_time = null; /** - * Output only. Location of the resource in the source system. Entry will be - * searchable by this location. By default, this should match the location of - * the EntryGroup containing this entry. A different value allows capturing - * source location for data external to GCP. + * Output only. Location of the resource in the source system. You can search + * the entry by this location. By default, this should match the location of + * the entry group containing this entry. A different value allows capturing + * the source location for data external to Google Cloud. * * Generated from protobuf field string location = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -94,33 +98,37 @@ class EntrySource extends \Google\Protobuf\Internal\Message * * @type string $resource * The name of the resource in the source system. - * The maximum size of the field is 4000 characters. + * Maximum length is 4,000 characters. * @type string $system * The name of the source system. - * The maximum size of the field is 64 characters. + * Maximum length is 64 characters. * @type string $platform * The platform containing the source system. - * The maximum size of the field is 64 characters. + * Maximum length is 64 characters. * @type string $display_name - * User friendly display name. - * The maximum size of the field is 500 characters. + * A user-friendly display name. + * Maximum length is 500 characters. * @type string $description - * Description of the Entry. - * The maximum size of the field is 2000 characters. + * A description of the data resource. + * Maximum length is 2,000 characters. * @type array|\Google\Protobuf\Internal\MapField $labels * User-defined labels. * The maximum size of keys and values is 128 characters each. * @type array<\Google\Cloud\Dataplex\V1\EntrySource\Ancestor>|\Google\Protobuf\Internal\RepeatedField $ancestors - * Immutable. The ancestors of the Entry in the source system. + * Immutable. The entries representing the ancestors of the data resource in + * the source system. * @type \Google\Protobuf\Timestamp $create_time - * The create time of the resource in the source system. + * The time when the resource was created in the source system. * @type \Google\Protobuf\Timestamp $update_time - * The update time of the resource in the source system. + * The time when the resource was last updated in the source system. If the + * entry exists in the system and its `EntrySource` has `update_time` + * populated, further updates to the `EntrySource` of the entry must provide + * incremental updates to its `update_time`. * @type string $location - * Output only. Location of the resource in the source system. Entry will be - * searchable by this location. By default, this should match the location of - * the EntryGroup containing this entry. A different value allows capturing - * source location for data external to GCP. + * Output only. Location of the resource in the source system. You can search + * the entry by this location. By default, this should match the location of + * the entry group containing this entry. A different value allows capturing + * the source location for data external to Google Cloud. * } */ public function __construct($data = NULL) { @@ -130,7 +138,7 @@ public function __construct($data = NULL) { /** * The name of the resource in the source system. - * The maximum size of the field is 4000 characters. + * Maximum length is 4,000 characters. * * Generated from protobuf field string resource = 1; * @return string @@ -142,7 +150,7 @@ public function getResource() /** * The name of the resource in the source system. - * The maximum size of the field is 4000 characters. + * Maximum length is 4,000 characters. * * Generated from protobuf field string resource = 1; * @param string $var @@ -158,7 +166,7 @@ public function setResource($var) /** * The name of the source system. - * The maximum size of the field is 64 characters. + * Maximum length is 64 characters. * * Generated from protobuf field string system = 2; * @return string @@ -170,7 +178,7 @@ public function getSystem() /** * The name of the source system. - * The maximum size of the field is 64 characters. + * Maximum length is 64 characters. * * Generated from protobuf field string system = 2; * @param string $var @@ -186,7 +194,7 @@ public function setSystem($var) /** * The platform containing the source system. - * The maximum size of the field is 64 characters. + * Maximum length is 64 characters. * * Generated from protobuf field string platform = 3; * @return string @@ -198,7 +206,7 @@ public function getPlatform() /** * The platform containing the source system. - * The maximum size of the field is 64 characters. + * Maximum length is 64 characters. * * Generated from protobuf field string platform = 3; * @param string $var @@ -213,8 +221,8 @@ public function setPlatform($var) } /** - * User friendly display name. - * The maximum size of the field is 500 characters. + * A user-friendly display name. + * Maximum length is 500 characters. * * Generated from protobuf field string display_name = 5; * @return string @@ -225,8 +233,8 @@ public function getDisplayName() } /** - * User friendly display name. - * The maximum size of the field is 500 characters. + * A user-friendly display name. + * Maximum length is 500 characters. * * Generated from protobuf field string display_name = 5; * @param string $var @@ -241,8 +249,8 @@ public function setDisplayName($var) } /** - * Description of the Entry. - * The maximum size of the field is 2000 characters. + * A description of the data resource. + * Maximum length is 2,000 characters. * * Generated from protobuf field string description = 6; * @return string @@ -253,8 +261,8 @@ public function getDescription() } /** - * Description of the Entry. - * The maximum size of the field is 2000 characters. + * A description of the data resource. + * Maximum length is 2,000 characters. * * Generated from protobuf field string description = 6; * @param string $var @@ -297,7 +305,8 @@ public function setLabels($var) } /** - * Immutable. The ancestors of the Entry in the source system. + * Immutable. The entries representing the ancestors of the data resource in + * the source system. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.EntrySource.Ancestor ancestors = 9 [(.google.api.field_behavior) = IMMUTABLE]; * @return \Google\Protobuf\Internal\RepeatedField @@ -308,7 +317,8 @@ public function getAncestors() } /** - * Immutable. The ancestors of the Entry in the source system. + * Immutable. The entries representing the ancestors of the data resource in + * the source system. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.EntrySource.Ancestor ancestors = 9 [(.google.api.field_behavior) = IMMUTABLE]; * @param array<\Google\Cloud\Dataplex\V1\EntrySource\Ancestor>|\Google\Protobuf\Internal\RepeatedField $var @@ -323,7 +333,7 @@ public function setAncestors($var) } /** - * The create time of the resource in the source system. + * The time when the resource was created in the source system. * * Generated from protobuf field .google.protobuf.Timestamp create_time = 10; * @return \Google\Protobuf\Timestamp|null @@ -344,7 +354,7 @@ public function clearCreateTime() } /** - * The create time of the resource in the source system. + * The time when the resource was created in the source system. * * Generated from protobuf field .google.protobuf.Timestamp create_time = 10; * @param \Google\Protobuf\Timestamp $var @@ -359,7 +369,10 @@ public function setCreateTime($var) } /** - * The update time of the resource in the source system. + * The time when the resource was last updated in the source system. If the + * entry exists in the system and its `EntrySource` has `update_time` + * populated, further updates to the `EntrySource` of the entry must provide + * incremental updates to its `update_time`. * * Generated from protobuf field .google.protobuf.Timestamp update_time = 11; * @return \Google\Protobuf\Timestamp|null @@ -380,7 +393,10 @@ public function clearUpdateTime() } /** - * The update time of the resource in the source system. + * The time when the resource was last updated in the source system. If the + * entry exists in the system and its `EntrySource` has `update_time` + * populated, further updates to the `EntrySource` of the entry must provide + * incremental updates to its `update_time`. * * Generated from protobuf field .google.protobuf.Timestamp update_time = 11; * @param \Google\Protobuf\Timestamp $var @@ -395,10 +411,10 @@ public function setUpdateTime($var) } /** - * Output only. Location of the resource in the source system. Entry will be - * searchable by this location. By default, this should match the location of - * the EntryGroup containing this entry. A different value allows capturing - * source location for data external to GCP. + * Output only. Location of the resource in the source system. You can search + * the entry by this location. By default, this should match the location of + * the entry group containing this entry. A different value allows capturing + * the source location for data external to Google Cloud. * * Generated from protobuf field string location = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return string @@ -409,10 +425,10 @@ public function getLocation() } /** - * Output only. Location of the resource in the source system. Entry will be - * searchable by this location. By default, this should match the location of - * the EntryGroup containing this entry. A different value allows capturing - * source location for data external to GCP. + * Output only. Location of the resource in the source system. You can search + * the entry by this location. By default, this should match the location of + * the entry group containing this entry. A different value allows capturing + * the source location for data external to Google Cloud. * * Generated from protobuf field string location = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param string $var diff --git a/Dataplex/src/V1/EntrySource/Ancestor.php b/Dataplex/src/V1/EntrySource/Ancestor.php index 8a0f14ad87c8..d9a84df78116 100644 --- a/Dataplex/src/V1/EntrySource/Ancestor.php +++ b/Dataplex/src/V1/EntrySource/Ancestor.php @@ -9,8 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Ancestor contains information about individual items in the hierarchy of - * an Entry. + * Information about individual items in the hierarchy that is associated with + * the data resource. * * Generated from protobuf message google.cloud.dataplex.v1.EntrySource.Ancestor */ diff --git a/Dataplex/src/V1/EntryType.php b/Dataplex/src/V1/EntryType.php index a5a4dcc45944..51e0fe89218c 100644 --- a/Dataplex/src/V1/EntryType.php +++ b/Dataplex/src/V1/EntryType.php @@ -61,15 +61,15 @@ class EntryType extends \Google\Protobuf\Internal\Message */ private $labels; /** - * Optional. This checksum is computed by the server based on the value of - * other fields, and may be sent on update and delete requests to ensure the - * client has an up-to-date value before proceeding. + * Optional. This checksum is computed by the service, and might be sent on + * update and delete requests to ensure the client has an up-to-date value + * before proceeding. * * Generated from protobuf field string etag = 8 [(.google.api.field_behavior) = OPTIONAL]; */ protected $etag = ''; /** - * Optional. Indicates the class this Entry Type belongs to, for example, + * Optional. Indicates the classes this Entry Type belongs to, for example, * TABLE, DATABASE, MODEL. * * Generated from protobuf field repeated string type_aliases = 9 [(.google.api.field_behavior) = OPTIONAL]; @@ -125,11 +125,11 @@ class EntryType extends \Google\Protobuf\Internal\Message * @type array|\Google\Protobuf\Internal\MapField $labels * Optional. User-defined labels for the EntryType. * @type string $etag - * Optional. This checksum is computed by the server based on the value of - * other fields, and may be sent on update and delete requests to ensure the - * client has an up-to-date value before proceeding. + * Optional. This checksum is computed by the service, and might be sent on + * update and delete requests to ensure the client has an up-to-date value + * before proceeding. * @type array|\Google\Protobuf\Internal\RepeatedField $type_aliases - * Optional. Indicates the class this Entry Type belongs to, for example, + * Optional. Indicates the classes this Entry Type belongs to, for example, * TABLE, DATABASE, MODEL. * @type string $platform * Optional. The platform that Entries of this type belongs to. @@ -356,9 +356,9 @@ public function setLabels($var) } /** - * Optional. This checksum is computed by the server based on the value of - * other fields, and may be sent on update and delete requests to ensure the - * client has an up-to-date value before proceeding. + * Optional. This checksum is computed by the service, and might be sent on + * update and delete requests to ensure the client has an up-to-date value + * before proceeding. * * Generated from protobuf field string etag = 8 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -369,9 +369,9 @@ public function getEtag() } /** - * Optional. This checksum is computed by the server based on the value of - * other fields, and may be sent on update and delete requests to ensure the - * client has an up-to-date value before proceeding. + * Optional. This checksum is computed by the service, and might be sent on + * update and delete requests to ensure the client has an up-to-date value + * before proceeding. * * Generated from protobuf field string etag = 8 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -386,7 +386,7 @@ public function setEtag($var) } /** - * Optional. Indicates the class this Entry Type belongs to, for example, + * Optional. Indicates the classes this Entry Type belongs to, for example, * TABLE, DATABASE, MODEL. * * Generated from protobuf field repeated string type_aliases = 9 [(.google.api.field_behavior) = OPTIONAL]; @@ -398,7 +398,7 @@ public function getTypeAliases() } /** - * Optional. Indicates the class this Entry Type belongs to, for example, + * Optional. Indicates the classes this Entry Type belongs to, for example, * TABLE, DATABASE, MODEL. * * Generated from protobuf field repeated string type_aliases = 9 [(.google.api.field_behavior) = OPTIONAL]; diff --git a/Dataplex/src/V1/EntryView.php b/Dataplex/src/V1/EntryView.php index 8070bb374123..b3cb7b133f2f 100644 --- a/Dataplex/src/V1/EntryView.php +++ b/Dataplex/src/V1/EntryView.php @@ -34,13 +34,13 @@ class EntryView const FULL = 2; /** * Returns aspects matching custom fields in GetEntryRequest. If the number of - * aspects would exceed 100, the first 100 will be returned. + * aspects exceeds 100, the first 100 will be returned. * * Generated from protobuf enum CUSTOM = 3; */ const CUSTOM = 3; /** - * Returns all aspects. If the number of aspects would exceed 100, the first + * Returns all aspects. If the number of aspects exceeds 100, the first * 100 will be returned. * * Generated from protobuf enum ALL = 4; diff --git a/Dataplex/src/V1/GetAspectTypeRequest.php b/Dataplex/src/V1/GetAspectTypeRequest.php index 9a15da81e83a..f7080fe1d521 100644 --- a/Dataplex/src/V1/GetAspectTypeRequest.php +++ b/Dataplex/src/V1/GetAspectTypeRequest.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Get AspectType request + * Get AspectType request. * * Generated from protobuf message google.cloud.dataplex.v1.GetAspectTypeRequest */ diff --git a/Dataplex/src/V1/GetEntryRequest.php b/Dataplex/src/V1/GetEntryRequest.php index 49581bf69832..6605c305d235 100644 --- a/Dataplex/src/V1/GetEntryRequest.php +++ b/Dataplex/src/V1/GetEntryRequest.php @@ -9,6 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** + * Get Entry request. + * * Generated from protobuf message google.cloud.dataplex.v1.GetEntryRequest */ class GetEntryRequest extends \Google\Protobuf\Internal\Message @@ -21,21 +23,22 @@ class GetEntryRequest extends \Google\Protobuf\Internal\Message */ protected $name = ''; /** - * Optional. View for controlling which parts of an entry are to be returned. + * Optional. View to control which parts of an entry the service should + * return. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryView view = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $view = 0; /** * Optional. Limits the aspects returned to the provided aspect types. - * Only works if the CUSTOM view is selected. + * It only works for CUSTOM view. * * Generated from protobuf field repeated string aspect_types = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $aspect_types; /** * Optional. Limits the aspects returned to those associated with the provided - * paths within the Entry. Only works if the CUSTOM view is selected. + * paths within the Entry. It only works for CUSTOM view. * * Generated from protobuf field repeated string paths = 4 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -66,13 +69,14 @@ public static function build(string $name): self * Required. The resource name of the Entry: * `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`. * @type int $view - * Optional. View for controlling which parts of an entry are to be returned. + * Optional. View to control which parts of an entry the service should + * return. * @type array|\Google\Protobuf\Internal\RepeatedField $aspect_types * Optional. Limits the aspects returned to the provided aspect types. - * Only works if the CUSTOM view is selected. + * It only works for CUSTOM view. * @type array|\Google\Protobuf\Internal\RepeatedField $paths * Optional. Limits the aspects returned to those associated with the provided - * paths within the Entry. Only works if the CUSTOM view is selected. + * paths within the Entry. It only works for CUSTOM view. * } */ public function __construct($data = NULL) { @@ -109,7 +113,8 @@ public function setName($var) } /** - * Optional. View for controlling which parts of an entry are to be returned. + * Optional. View to control which parts of an entry the service should + * return. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryView view = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -120,7 +125,8 @@ public function getView() } /** - * Optional. View for controlling which parts of an entry are to be returned. + * Optional. View to control which parts of an entry the service should + * return. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryView view = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var @@ -136,7 +142,7 @@ public function setView($var) /** * Optional. Limits the aspects returned to the provided aspect types. - * Only works if the CUSTOM view is selected. + * It only works for CUSTOM view. * * Generated from protobuf field repeated string aspect_types = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField @@ -148,7 +154,7 @@ public function getAspectTypes() /** * Optional. Limits the aspects returned to the provided aspect types. - * Only works if the CUSTOM view is selected. + * It only works for CUSTOM view. * * Generated from protobuf field repeated string aspect_types = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var @@ -164,7 +170,7 @@ public function setAspectTypes($var) /** * Optional. Limits the aspects returned to those associated with the provided - * paths within the Entry. Only works if the CUSTOM view is selected. + * paths within the Entry. It only works for CUSTOM view. * * Generated from protobuf field repeated string paths = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField @@ -176,7 +182,7 @@ public function getPaths() /** * Optional. Limits the aspects returned to those associated with the provided - * paths within the Entry. Only works if the CUSTOM view is selected. + * paths within the Entry. It only works for CUSTOM view. * * Generated from protobuf field repeated string paths = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Dataplex/src/V1/GetEntryTypeRequest.php b/Dataplex/src/V1/GetEntryTypeRequest.php index 93096ecfa34b..4900b0462988 100644 --- a/Dataplex/src/V1/GetEntryTypeRequest.php +++ b/Dataplex/src/V1/GetEntryTypeRequest.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Get EntryType request + * Get EntryType request. * * Generated from protobuf message google.cloud.dataplex.v1.GetEntryTypeRequest */ diff --git a/Dataplex/src/V1/GetMetadataJobRequest.php b/Dataplex/src/V1/GetMetadataJobRequest.php new file mode 100644 index 000000000000..2051a287e1a1 --- /dev/null +++ b/Dataplex/src/V1/GetMetadataJobRequest.php @@ -0,0 +1,86 @@ +google.cloud.dataplex.v1.GetMetadataJobRequest + */ +class GetMetadataJobRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the metadata job, in the format + * `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $name = ''; + + /** + * @param string $name Required. The resource name of the metadata job, in the format + * `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`. Please see + * {@see CatalogServiceClient::metadataJobName()} for help formatting this field. + * + * @return \Google\Cloud\Dataplex\V1\GetMetadataJobRequest + * + * @experimental + */ + public static function build(string $name): self + { + return (new self()) + ->setName($name); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Required. The resource name of the metadata job, in the format + * `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\Catalog::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the metadata job, in the format + * `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Required. The resource name of the metadata job, in the format + * `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + +} + diff --git a/Dataplex/src/V1/ImportItem.php b/Dataplex/src/V1/ImportItem.php new file mode 100644 index 000000000000..15420b56d731 --- /dev/null +++ b/Dataplex/src/V1/ImportItem.php @@ -0,0 +1,265 @@ +google.cloud.dataplex.v1.ImportItem + */ +class ImportItem extends \Google\Protobuf\Internal\Message +{ + /** + * Information about an entry and its attached aspects. + * + * Generated from protobuf field .google.cloud.dataplex.v1.Entry entry = 1; + */ + protected $entry = null; + /** + * The fields to update, in paths that are relative to the `Entry` resource. + * Separate each field with a comma. + * In `FULL` entry sync mode, Dataplex includes the paths of all of the fields + * for an entry that can be modified, including aspects. This means that + * Dataplex replaces the existing entry with the entry in the metadata import + * file. All modifiable fields are updated, regardless of the fields that are + * listed in the update mask, and regardless of whether a field is present + * in the `entry` object. + * The `update_mask` field is ignored when an entry is created or re-created. + * Dataplex also determines which entries and aspects to modify by comparing + * the values and timestamps that you provide in the metadata import file with + * the values and timestamps that exist in your project. For more information, + * see [Comparison + * logic](https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic). + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + */ + protected $update_mask = null; + /** + * The aspects to modify. Supports the following syntaxes: + * * `{aspect_type_reference}`: matches aspects that belong to the specified + * aspect type and are attached directly to the entry. + * * `{aspect_type_reference}@{path}`: matches aspects that belong to the + * specified aspect type and path. + * * `{aspect_type_reference}@*`: matches aspects that belong to the specified + * aspect type for all paths. + * Replace `{aspect_type_reference}` with a reference to the aspect type, in + * the format + * `{project_id_or_number}.{location_id}.{aspect_type_id}`. + * If you leave this field empty, it is treated as specifying exactly those + * aspects that are present within the specified entry. + * In `FULL` entry sync mode, Dataplex implicitly adds the keys for all of the + * required aspects of an entry. + * + * Generated from protobuf field repeated string aspect_keys = 3; + */ + private $aspect_keys; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type \Google\Cloud\Dataplex\V1\Entry $entry + * Information about an entry and its attached aspects. + * @type \Google\Protobuf\FieldMask $update_mask + * The fields to update, in paths that are relative to the `Entry` resource. + * Separate each field with a comma. + * In `FULL` entry sync mode, Dataplex includes the paths of all of the fields + * for an entry that can be modified, including aspects. This means that + * Dataplex replaces the existing entry with the entry in the metadata import + * file. All modifiable fields are updated, regardless of the fields that are + * listed in the update mask, and regardless of whether a field is present + * in the `entry` object. + * The `update_mask` field is ignored when an entry is created or re-created. + * Dataplex also determines which entries and aspects to modify by comparing + * the values and timestamps that you provide in the metadata import file with + * the values and timestamps that exist in your project. For more information, + * see [Comparison + * logic](https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic). + * @type array|\Google\Protobuf\Internal\RepeatedField $aspect_keys + * The aspects to modify. Supports the following syntaxes: + * * `{aspect_type_reference}`: matches aspects that belong to the specified + * aspect type and are attached directly to the entry. + * * `{aspect_type_reference}@{path}`: matches aspects that belong to the + * specified aspect type and path. + * * `{aspect_type_reference}@*`: matches aspects that belong to the specified + * aspect type for all paths. + * Replace `{aspect_type_reference}` with a reference to the aspect type, in + * the format + * `{project_id_or_number}.{location_id}.{aspect_type_id}`. + * If you leave this field empty, it is treated as specifying exactly those + * aspects that are present within the specified entry. + * In `FULL` entry sync mode, Dataplex implicitly adds the keys for all of the + * required aspects of an entry. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\Catalog::initOnce(); + parent::__construct($data); + } + + /** + * Information about an entry and its attached aspects. + * + * Generated from protobuf field .google.cloud.dataplex.v1.Entry entry = 1; + * @return \Google\Cloud\Dataplex\V1\Entry|null + */ + public function getEntry() + { + return $this->entry; + } + + public function hasEntry() + { + return isset($this->entry); + } + + public function clearEntry() + { + unset($this->entry); + } + + /** + * Information about an entry and its attached aspects. + * + * Generated from protobuf field .google.cloud.dataplex.v1.Entry entry = 1; + * @param \Google\Cloud\Dataplex\V1\Entry $var + * @return $this + */ + public function setEntry($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\Entry::class); + $this->entry = $var; + + return $this; + } + + /** + * The fields to update, in paths that are relative to the `Entry` resource. + * Separate each field with a comma. + * In `FULL` entry sync mode, Dataplex includes the paths of all of the fields + * for an entry that can be modified, including aspects. This means that + * Dataplex replaces the existing entry with the entry in the metadata import + * file. All modifiable fields are updated, regardless of the fields that are + * listed in the update mask, and regardless of whether a field is present + * in the `entry` object. + * The `update_mask` field is ignored when an entry is created or re-created. + * Dataplex also determines which entries and aspects to modify by comparing + * the values and timestamps that you provide in the metadata import file with + * the values and timestamps that exist in your project. For more information, + * see [Comparison + * logic](https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic). + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + * @return \Google\Protobuf\FieldMask|null + */ + public function getUpdateMask() + { + return $this->update_mask; + } + + public function hasUpdateMask() + { + return isset($this->update_mask); + } + + public function clearUpdateMask() + { + unset($this->update_mask); + } + + /** + * The fields to update, in paths that are relative to the `Entry` resource. + * Separate each field with a comma. + * In `FULL` entry sync mode, Dataplex includes the paths of all of the fields + * for an entry that can be modified, including aspects. This means that + * Dataplex replaces the existing entry with the entry in the metadata import + * file. All modifiable fields are updated, regardless of the fields that are + * listed in the update mask, and regardless of whether a field is present + * in the `entry` object. + * The `update_mask` field is ignored when an entry is created or re-created. + * Dataplex also determines which entries and aspects to modify by comparing + * the values and timestamps that you provide in the metadata import file with + * the values and timestamps that exist in your project. For more information, + * see [Comparison + * logic](https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic). + * + * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2; + * @param \Google\Protobuf\FieldMask $var + * @return $this + */ + public function setUpdateMask($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); + $this->update_mask = $var; + + return $this; + } + + /** + * The aspects to modify. Supports the following syntaxes: + * * `{aspect_type_reference}`: matches aspects that belong to the specified + * aspect type and are attached directly to the entry. + * * `{aspect_type_reference}@{path}`: matches aspects that belong to the + * specified aspect type and path. + * * `{aspect_type_reference}@*`: matches aspects that belong to the specified + * aspect type for all paths. + * Replace `{aspect_type_reference}` with a reference to the aspect type, in + * the format + * `{project_id_or_number}.{location_id}.{aspect_type_id}`. + * If you leave this field empty, it is treated as specifying exactly those + * aspects that are present within the specified entry. + * In `FULL` entry sync mode, Dataplex implicitly adds the keys for all of the + * required aspects of an entry. + * + * Generated from protobuf field repeated string aspect_keys = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAspectKeys() + { + return $this->aspect_keys; + } + + /** + * The aspects to modify. Supports the following syntaxes: + * * `{aspect_type_reference}`: matches aspects that belong to the specified + * aspect type and are attached directly to the entry. + * * `{aspect_type_reference}@{path}`: matches aspects that belong to the + * specified aspect type and path. + * * `{aspect_type_reference}@*`: matches aspects that belong to the specified + * aspect type for all paths. + * Replace `{aspect_type_reference}` with a reference to the aspect type, in + * the format + * `{project_id_or_number}.{location_id}.{aspect_type_id}`. + * If you leave this field empty, it is treated as specifying exactly those + * aspects that are present within the specified entry. + * In `FULL` entry sync mode, Dataplex implicitly adds the keys for all of the + * required aspects of an entry. + * + * Generated from protobuf field repeated string aspect_keys = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAspectKeys($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->aspect_keys = $arr; + + return $this; + } + +} + diff --git a/Dataplex/src/V1/ListAspectTypesRequest.php b/Dataplex/src/V1/ListAspectTypesRequest.php index a11659483447..1173c349f956 100644 --- a/Dataplex/src/V1/ListAspectTypesRequest.php +++ b/Dataplex/src/V1/ListAspectTypesRequest.php @@ -9,7 +9,7 @@ use Google\Protobuf\Internal\GPBUtil; /** - * List AspectTypes request + * List AspectTypes request. * * Generated from protobuf message google.cloud.dataplex.v1.ListAspectTypesRequest */ @@ -18,16 +18,16 @@ class ListAspectTypesRequest extends \Google\Protobuf\Internal\Message /** * Required. The resource name of the AspectType location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $parent = ''; /** * Optional. Maximum number of AspectTypes to return. The service may return - * fewer than this value. If unspecified, at most 10 AspectTypes will be - * returned. The maximum value is 1000; values above 1000 will be coerced to - * 1000. + * fewer than this value. If unspecified, the service returns at most 10 + * AspectTypes. The maximum value is 1000; values above 1000 will be coerced + * to 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -35,25 +35,25 @@ class ListAspectTypesRequest extends \Google\Protobuf\Internal\Message /** * Optional. Page token received from a previous `ListAspectTypes` call. * Provide this to retrieve the subsequent page. When paginating, all other - * parameters provided to `ListAspectTypes` must match the call that provided - * the page token. + * parameters you provide to `ListAspectTypes` must match the call that + * provided the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** * Optional. Filter request. Filters are case-sensitive. - * The following formats are supported: - * labels.key1 = "value1" - * labels:key1 - * name = "value" - * These restrictions can be coinjoined with AND, OR and NOT conjunctions. + * The service supports the following formats: + * * labels.key1 = "value1" + * * labels:key1 + * * name = "value" + * These restrictions can be conjoined with AND, OR, and NOT conjunctions. * * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $filter = ''; /** - * Optional. Order by fields (`name` or `create_time`) for the result. + * Optional. Orders the result by `name` or `create_time` fields. * If not specified, the ordering is undefined. * * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; @@ -63,7 +63,7 @@ class ListAspectTypesRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The resource name of the AspectType location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. Please see + * where `location_id` refers to a Google Cloud region. Please see * {@see CatalogServiceClient::locationName()} for help formatting this field. * * @return \Google\Cloud\Dataplex\V1\ListAspectTypesRequest @@ -85,26 +85,26 @@ public static function build(string $parent): self * @type string $parent * Required. The resource name of the AspectType location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * @type int $page_size * Optional. Maximum number of AspectTypes to return. The service may return - * fewer than this value. If unspecified, at most 10 AspectTypes will be - * returned. The maximum value is 1000; values above 1000 will be coerced to - * 1000. + * fewer than this value. If unspecified, the service returns at most 10 + * AspectTypes. The maximum value is 1000; values above 1000 will be coerced + * to 1000. * @type string $page_token * Optional. Page token received from a previous `ListAspectTypes` call. * Provide this to retrieve the subsequent page. When paginating, all other - * parameters provided to `ListAspectTypes` must match the call that provided - * the page token. + * parameters you provide to `ListAspectTypes` must match the call that + * provided the page token. * @type string $filter * Optional. Filter request. Filters are case-sensitive. - * The following formats are supported: - * labels.key1 = "value1" - * labels:key1 - * name = "value" - * These restrictions can be coinjoined with AND, OR and NOT conjunctions. + * The service supports the following formats: + * * labels.key1 = "value1" + * * labels:key1 + * * name = "value" + * These restrictions can be conjoined with AND, OR, and NOT conjunctions. * @type string $order_by - * Optional. Order by fields (`name` or `create_time`) for the result. + * Optional. Orders the result by `name` or `create_time` fields. * If not specified, the ordering is undefined. * } */ @@ -116,7 +116,7 @@ public function __construct($data = NULL) { /** * Required. The resource name of the AspectType location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -129,7 +129,7 @@ public function getParent() /** * Required. The resource name of the AspectType location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -145,9 +145,9 @@ public function setParent($var) /** * Optional. Maximum number of AspectTypes to return. The service may return - * fewer than this value. If unspecified, at most 10 AspectTypes will be - * returned. The maximum value is 1000; values above 1000 will be coerced to - * 1000. + * fewer than this value. If unspecified, the service returns at most 10 + * AspectTypes. The maximum value is 1000; values above 1000 will be coerced + * to 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -159,9 +159,9 @@ public function getPageSize() /** * Optional. Maximum number of AspectTypes to return. The service may return - * fewer than this value. If unspecified, at most 10 AspectTypes will be - * returned. The maximum value is 1000; values above 1000 will be coerced to - * 1000. + * fewer than this value. If unspecified, the service returns at most 10 + * AspectTypes. The maximum value is 1000; values above 1000 will be coerced + * to 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var @@ -178,8 +178,8 @@ public function setPageSize($var) /** * Optional. Page token received from a previous `ListAspectTypes` call. * Provide this to retrieve the subsequent page. When paginating, all other - * parameters provided to `ListAspectTypes` must match the call that provided - * the page token. + * parameters you provide to `ListAspectTypes` must match the call that + * provided the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -192,8 +192,8 @@ public function getPageToken() /** * Optional. Page token received from a previous `ListAspectTypes` call. * Provide this to retrieve the subsequent page. When paginating, all other - * parameters provided to `ListAspectTypes` must match the call that provided - * the page token. + * parameters you provide to `ListAspectTypes` must match the call that + * provided the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -209,11 +209,11 @@ public function setPageToken($var) /** * Optional. Filter request. Filters are case-sensitive. - * The following formats are supported: - * labels.key1 = "value1" - * labels:key1 - * name = "value" - * These restrictions can be coinjoined with AND, OR and NOT conjunctions. + * The service supports the following formats: + * * labels.key1 = "value1" + * * labels:key1 + * * name = "value" + * These restrictions can be conjoined with AND, OR, and NOT conjunctions. * * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -225,11 +225,11 @@ public function getFilter() /** * Optional. Filter request. Filters are case-sensitive. - * The following formats are supported: - * labels.key1 = "value1" - * labels:key1 - * name = "value" - * These restrictions can be coinjoined with AND, OR and NOT conjunctions. + * The service supports the following formats: + * * labels.key1 = "value1" + * * labels:key1 + * * name = "value" + * These restrictions can be conjoined with AND, OR, and NOT conjunctions. * * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -244,7 +244,7 @@ public function setFilter($var) } /** - * Optional. Order by fields (`name` or `create_time`) for the result. + * Optional. Orders the result by `name` or `create_time` fields. * If not specified, the ordering is undefined. * * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; @@ -256,7 +256,7 @@ public function getOrderBy() } /** - * Optional. Order by fields (`name` or `create_time`) for the result. + * Optional. Orders the result by `name` or `create_time` fields. * If not specified, the ordering is undefined. * * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; diff --git a/Dataplex/src/V1/ListAspectTypesResponse.php b/Dataplex/src/V1/ListAspectTypesResponse.php index c5c8db54c1b0..9c49bf08c014 100644 --- a/Dataplex/src/V1/ListAspectTypesResponse.php +++ b/Dataplex/src/V1/ListAspectTypesResponse.php @@ -9,14 +9,14 @@ use Google\Protobuf\Internal\GPBUtil; /** - * List AspectTypes response + * List AspectTypes response. * * Generated from protobuf message google.cloud.dataplex.v1.ListAspectTypesResponse */ class ListAspectTypesResponse extends \Google\Protobuf\Internal\Message { /** - * ListAspectTypes under the given parent location. + * AspectTypes under the given parent location. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.AspectType aspect_types = 1; */ @@ -29,7 +29,7 @@ class ListAspectTypesResponse extends \Google\Protobuf\Internal\Message */ protected $next_page_token = ''; /** - * Locations that could not be reached. + * Locations that the service couldn't reach. * * Generated from protobuf field repeated string unreachable_locations = 3; */ @@ -42,12 +42,12 @@ class ListAspectTypesResponse extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\Dataplex\V1\AspectType>|\Google\Protobuf\Internal\RepeatedField $aspect_types - * ListAspectTypes under the given parent location. + * AspectTypes under the given parent location. * @type string $next_page_token * Token to retrieve the next page of results, or empty if there are no more * results in the list. * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable_locations - * Locations that could not be reached. + * Locations that the service couldn't reach. * } */ public function __construct($data = NULL) { @@ -56,7 +56,7 @@ public function __construct($data = NULL) { } /** - * ListAspectTypes under the given parent location. + * AspectTypes under the given parent location. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.AspectType aspect_types = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -67,7 +67,7 @@ public function getAspectTypes() } /** - * ListAspectTypes under the given parent location. + * AspectTypes under the given parent location. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.AspectType aspect_types = 1; * @param array<\Google\Cloud\Dataplex\V1\AspectType>|\Google\Protobuf\Internal\RepeatedField $var @@ -110,7 +110,7 @@ public function setNextPageToken($var) } /** - * Locations that could not be reached. + * Locations that the service couldn't reach. * * Generated from protobuf field repeated string unreachable_locations = 3; * @return \Google\Protobuf\Internal\RepeatedField @@ -121,7 +121,7 @@ public function getUnreachableLocations() } /** - * Locations that could not be reached. + * Locations that the service couldn't reach. * * Generated from protobuf field repeated string unreachable_locations = 3; * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Dataplex/src/V1/ListEntriesRequest.php b/Dataplex/src/V1/ListEntriesRequest.php index 025edaca17f7..046aa692a122 100644 --- a/Dataplex/src/V1/ListEntriesRequest.php +++ b/Dataplex/src/V1/ListEntriesRequest.php @@ -9,6 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** + * List Entries request. + * * Generated from protobuf message google.cloud.dataplex.v1.ListEntriesRequest */ class ListEntriesRequest extends \Google\Protobuf\Internal\Message @@ -21,30 +23,37 @@ class ListEntriesRequest extends \Google\Protobuf\Internal\Message */ protected $parent = ''; /** + * Optional. Number of items to return per page. If there are remaining + * results, the service returns a next_page_token. If unspecified, the service + * returns at most 10 Entries. The maximum value is 100; values above 100 will + * be coerced to 100. + * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_size = 0; /** - * Optional. The pagination token returned by a previous request. + * Optional. Page token received from a previous `ListEntries` call. Provide + * this to retrieve the subsequent page. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** - * Optional. A filter on the entries to return. - * Filters are case-sensitive. - * The request can be filtered by the following fields: - * entry_type, entry_source.display_name. - * The comparison operators are =, !=, <, >, <=, >= (strings are compared - * according to lexical order) - * The logical operators AND, OR, NOT can be used - * in the filter. Wildcard "*" can be used, but for entry_type the full - * project id or number needs to be provided. Example filter expressions: - * "entry_source.display_name=AnExampleDisplayName" - * "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" - * "entry_type=projects/example-project/locations/us/entryTypes/a* OR - * entry_type=projects/another-project/locations/*" - * "NOT entry_source.display_name=AnotherExampleDisplayName" + * Optional. A filter on the entries to return. Filters are case-sensitive. + * You can filter the request by the following fields: + * * entry_type + * * entry_source.display_name + * The comparison operators are =, !=, <, >, <=, >=. The service compares + * strings according to lexical order. + * You can use the logical operators AND, OR, NOT in the filter. + * You can use Wildcard "*", but for entry_type you need to provide the + * full project id or number. + * Example filter expressions: + * * "entry_source.display_name=AnExampleDisplayName" + * * "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" + * * "entry_type=projects/example-project/locations/us/entryTypes/a* OR + * entry_type=projects/another-project/locations/*" + * * "NOT entry_source.display_name=AnotherExampleDisplayName" * * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -75,23 +84,29 @@ public static function build(string $parent): self * Required. The resource name of the parent Entry Group: * `projects/{project}/locations/{location}/entryGroups/{entry_group}`. * @type int $page_size + * Optional. Number of items to return per page. If there are remaining + * results, the service returns a next_page_token. If unspecified, the service + * returns at most 10 Entries. The maximum value is 100; values above 100 will + * be coerced to 100. * @type string $page_token - * Optional. The pagination token returned by a previous request. + * Optional. Page token received from a previous `ListEntries` call. Provide + * this to retrieve the subsequent page. * @type string $filter - * Optional. A filter on the entries to return. - * Filters are case-sensitive. - * The request can be filtered by the following fields: - * entry_type, entry_source.display_name. - * The comparison operators are =, !=, <, >, <=, >= (strings are compared - * according to lexical order) - * The logical operators AND, OR, NOT can be used - * in the filter. Wildcard "*" can be used, but for entry_type the full - * project id or number needs to be provided. Example filter expressions: - * "entry_source.display_name=AnExampleDisplayName" - * "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" - * "entry_type=projects/example-project/locations/us/entryTypes/a* OR - * entry_type=projects/another-project/locations/*" - * "NOT entry_source.display_name=AnotherExampleDisplayName" + * Optional. A filter on the entries to return. Filters are case-sensitive. + * You can filter the request by the following fields: + * * entry_type + * * entry_source.display_name + * The comparison operators are =, !=, <, >, <=, >=. The service compares + * strings according to lexical order. + * You can use the logical operators AND, OR, NOT in the filter. + * You can use Wildcard "*", but for entry_type you need to provide the + * full project id or number. + * Example filter expressions: + * * "entry_source.display_name=AnExampleDisplayName" + * * "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" + * * "entry_type=projects/example-project/locations/us/entryTypes/a* OR + * entry_type=projects/another-project/locations/*" + * * "NOT entry_source.display_name=AnotherExampleDisplayName" * } */ public function __construct($data = NULL) { @@ -128,6 +143,11 @@ public function setParent($var) } /** + * Optional. Number of items to return per page. If there are remaining + * results, the service returns a next_page_token. If unspecified, the service + * returns at most 10 Entries. The maximum value is 100; values above 100 will + * be coerced to 100. + * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ @@ -137,6 +157,11 @@ public function getPageSize() } /** + * Optional. Number of items to return per page. If there are remaining + * results, the service returns a next_page_token. If unspecified, the service + * returns at most 10 Entries. The maximum value is 100; values above 100 will + * be coerced to 100. + * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this @@ -150,7 +175,8 @@ public function setPageSize($var) } /** - * Optional. The pagination token returned by a previous request. + * Optional. Page token received from a previous `ListEntries` call. Provide + * this to retrieve the subsequent page. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -161,7 +187,8 @@ public function getPageToken() } /** - * Optional. The pagination token returned by a previous request. + * Optional. Page token received from a previous `ListEntries` call. Provide + * this to retrieve the subsequent page. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -176,20 +203,21 @@ public function setPageToken($var) } /** - * Optional. A filter on the entries to return. - * Filters are case-sensitive. - * The request can be filtered by the following fields: - * entry_type, entry_source.display_name. - * The comparison operators are =, !=, <, >, <=, >= (strings are compared - * according to lexical order) - * The logical operators AND, OR, NOT can be used - * in the filter. Wildcard "*" can be used, but for entry_type the full - * project id or number needs to be provided. Example filter expressions: - * "entry_source.display_name=AnExampleDisplayName" - * "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" - * "entry_type=projects/example-project/locations/us/entryTypes/a* OR - * entry_type=projects/another-project/locations/*" - * "NOT entry_source.display_name=AnotherExampleDisplayName" + * Optional. A filter on the entries to return. Filters are case-sensitive. + * You can filter the request by the following fields: + * * entry_type + * * entry_source.display_name + * The comparison operators are =, !=, <, >, <=, >=. The service compares + * strings according to lexical order. + * You can use the logical operators AND, OR, NOT in the filter. + * You can use Wildcard "*", but for entry_type you need to provide the + * full project id or number. + * Example filter expressions: + * * "entry_source.display_name=AnExampleDisplayName" + * * "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" + * * "entry_type=projects/example-project/locations/us/entryTypes/a* OR + * entry_type=projects/another-project/locations/*" + * * "NOT entry_source.display_name=AnotherExampleDisplayName" * * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -200,20 +228,21 @@ public function getFilter() } /** - * Optional. A filter on the entries to return. - * Filters are case-sensitive. - * The request can be filtered by the following fields: - * entry_type, entry_source.display_name. - * The comparison operators are =, !=, <, >, <=, >= (strings are compared - * according to lexical order) - * The logical operators AND, OR, NOT can be used - * in the filter. Wildcard "*" can be used, but for entry_type the full - * project id or number needs to be provided. Example filter expressions: - * "entry_source.display_name=AnExampleDisplayName" - * "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" - * "entry_type=projects/example-project/locations/us/entryTypes/a* OR - * entry_type=projects/another-project/locations/*" - * "NOT entry_source.display_name=AnotherExampleDisplayName" + * Optional. A filter on the entries to return. Filters are case-sensitive. + * You can filter the request by the following fields: + * * entry_type + * * entry_source.display_name + * The comparison operators are =, !=, <, >, <=, >=. The service compares + * strings according to lexical order. + * You can use the logical operators AND, OR, NOT in the filter. + * You can use Wildcard "*", but for entry_type you need to provide the + * full project id or number. + * Example filter expressions: + * * "entry_source.display_name=AnExampleDisplayName" + * * "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" + * * "entry_type=projects/example-project/locations/us/entryTypes/a* OR + * entry_type=projects/another-project/locations/*" + * * "NOT entry_source.display_name=AnotherExampleDisplayName" * * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/Dataplex/src/V1/ListEntriesResponse.php b/Dataplex/src/V1/ListEntriesResponse.php index 0c6c72207eb5..50558649c141 100644 --- a/Dataplex/src/V1/ListEntriesResponse.php +++ b/Dataplex/src/V1/ListEntriesResponse.php @@ -9,18 +9,21 @@ use Google\Protobuf\Internal\GPBUtil; /** + * List Entries response. + * * Generated from protobuf message google.cloud.dataplex.v1.ListEntriesResponse */ class ListEntriesResponse extends \Google\Protobuf\Internal\Message { /** - * The list of entries. + * The list of entries under the given parent location. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.Entry entries = 1; */ private $entries; /** - * Pagination token. + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. * * Generated from protobuf field string next_page_token = 2; */ @@ -33,9 +36,10 @@ class ListEntriesResponse extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\Dataplex\V1\Entry>|\Google\Protobuf\Internal\RepeatedField $entries - * The list of entries. + * The list of entries under the given parent location. * @type string $next_page_token - * Pagination token. + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. * } */ public function __construct($data = NULL) { @@ -44,7 +48,7 @@ public function __construct($data = NULL) { } /** - * The list of entries. + * The list of entries under the given parent location. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.Entry entries = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -55,7 +59,7 @@ public function getEntries() } /** - * The list of entries. + * The list of entries under the given parent location. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.Entry entries = 1; * @param array<\Google\Cloud\Dataplex\V1\Entry>|\Google\Protobuf\Internal\RepeatedField $var @@ -70,7 +74,8 @@ public function setEntries($var) } /** - * Pagination token. + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. * * Generated from protobuf field string next_page_token = 2; * @return string @@ -81,7 +86,8 @@ public function getNextPageToken() } /** - * Pagination token. + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. * * Generated from protobuf field string next_page_token = 2; * @param string $var diff --git a/Dataplex/src/V1/ListEntryGroupsRequest.php b/Dataplex/src/V1/ListEntryGroupsRequest.php index 6df7e43a8757..0c475602d396 100644 --- a/Dataplex/src/V1/ListEntryGroupsRequest.php +++ b/Dataplex/src/V1/ListEntryGroupsRequest.php @@ -18,16 +18,16 @@ class ListEntryGroupsRequest extends \Google\Protobuf\Internal\Message /** * Required. The resource name of the entryGroup location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $parent = ''; /** * Optional. Maximum number of EntryGroups to return. The service may return - * fewer than this value. If unspecified, at most 10 EntryGroups will be - * returned. The maximum value is 1000; values above 1000 will be coerced to - * 1000. + * fewer than this value. If unspecified, the service returns at most 10 + * EntryGroups. The maximum value is 1000; values above 1000 will be coerced + * to 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -35,8 +35,8 @@ class ListEntryGroupsRequest extends \Google\Protobuf\Internal\Message /** * Optional. Page token received from a previous `ListEntryGroups` call. * Provide this to retrieve the subsequent page. When paginating, all other - * parameters provided to `ListEntryGroups` must match the call that provided - * the page token. + * parameters you provide to `ListEntryGroups` must match the call that + * provided the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -57,7 +57,7 @@ class ListEntryGroupsRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The resource name of the entryGroup location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. Please see + * where `location_id` refers to a Google Cloud region. Please see * {@see CatalogServiceClient::locationName()} for help formatting this field. * * @return \Google\Cloud\Dataplex\V1\ListEntryGroupsRequest @@ -79,17 +79,17 @@ public static function build(string $parent): self * @type string $parent * Required. The resource name of the entryGroup location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * @type int $page_size * Optional. Maximum number of EntryGroups to return. The service may return - * fewer than this value. If unspecified, at most 10 EntryGroups will be - * returned. The maximum value is 1000; values above 1000 will be coerced to - * 1000. + * fewer than this value. If unspecified, the service returns at most 10 + * EntryGroups. The maximum value is 1000; values above 1000 will be coerced + * to 1000. * @type string $page_token * Optional. Page token received from a previous `ListEntryGroups` call. * Provide this to retrieve the subsequent page. When paginating, all other - * parameters provided to `ListEntryGroups` must match the call that provided - * the page token. + * parameters you provide to `ListEntryGroups` must match the call that + * provided the page token. * @type string $filter * Optional. Filter request. * @type string $order_by @@ -104,7 +104,7 @@ public function __construct($data = NULL) { /** * Required. The resource name of the entryGroup location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -117,7 +117,7 @@ public function getParent() /** * Required. The resource name of the entryGroup location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -133,9 +133,9 @@ public function setParent($var) /** * Optional. Maximum number of EntryGroups to return. The service may return - * fewer than this value. If unspecified, at most 10 EntryGroups will be - * returned. The maximum value is 1000; values above 1000 will be coerced to - * 1000. + * fewer than this value. If unspecified, the service returns at most 10 + * EntryGroups. The maximum value is 1000; values above 1000 will be coerced + * to 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -147,9 +147,9 @@ public function getPageSize() /** * Optional. Maximum number of EntryGroups to return. The service may return - * fewer than this value. If unspecified, at most 10 EntryGroups will be - * returned. The maximum value is 1000; values above 1000 will be coerced to - * 1000. + * fewer than this value. If unspecified, the service returns at most 10 + * EntryGroups. The maximum value is 1000; values above 1000 will be coerced + * to 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var @@ -166,8 +166,8 @@ public function setPageSize($var) /** * Optional. Page token received from a previous `ListEntryGroups` call. * Provide this to retrieve the subsequent page. When paginating, all other - * parameters provided to `ListEntryGroups` must match the call that provided - * the page token. + * parameters you provide to `ListEntryGroups` must match the call that + * provided the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -180,8 +180,8 @@ public function getPageToken() /** * Optional. Page token received from a previous `ListEntryGroups` call. * Provide this to retrieve the subsequent page. When paginating, all other - * parameters provided to `ListEntryGroups` must match the call that provided - * the page token. + * parameters you provide to `ListEntryGroups` must match the call that + * provided the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/Dataplex/src/V1/ListEntryGroupsResponse.php b/Dataplex/src/V1/ListEntryGroupsResponse.php index fc870fdfad86..81101f29fbf2 100644 --- a/Dataplex/src/V1/ListEntryGroupsResponse.php +++ b/Dataplex/src/V1/ListEntryGroupsResponse.php @@ -9,14 +9,14 @@ use Google\Protobuf\Internal\GPBUtil; /** - * List ListEntryGroups response. + * List entry groups response. * * Generated from protobuf message google.cloud.dataplex.v1.ListEntryGroupsResponse */ class ListEntryGroupsResponse extends \Google\Protobuf\Internal\Message { /** - * ListEntryGroups under the given parent location. + * Entry groups under the given parent location. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.EntryGroup entry_groups = 1; */ @@ -29,7 +29,7 @@ class ListEntryGroupsResponse extends \Google\Protobuf\Internal\Message */ protected $next_page_token = ''; /** - * Locations that could not be reached. + * Locations that the service couldn't reach. * * Generated from protobuf field repeated string unreachable_locations = 3; */ @@ -42,12 +42,12 @@ class ListEntryGroupsResponse extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\Dataplex\V1\EntryGroup>|\Google\Protobuf\Internal\RepeatedField $entry_groups - * ListEntryGroups under the given parent location. + * Entry groups under the given parent location. * @type string $next_page_token * Token to retrieve the next page of results, or empty if there are no more * results in the list. * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable_locations - * Locations that could not be reached. + * Locations that the service couldn't reach. * } */ public function __construct($data = NULL) { @@ -56,7 +56,7 @@ public function __construct($data = NULL) { } /** - * ListEntryGroups under the given parent location. + * Entry groups under the given parent location. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.EntryGroup entry_groups = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -67,7 +67,7 @@ public function getEntryGroups() } /** - * ListEntryGroups under the given parent location. + * Entry groups under the given parent location. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.EntryGroup entry_groups = 1; * @param array<\Google\Cloud\Dataplex\V1\EntryGroup>|\Google\Protobuf\Internal\RepeatedField $var @@ -110,7 +110,7 @@ public function setNextPageToken($var) } /** - * Locations that could not be reached. + * Locations that the service couldn't reach. * * Generated from protobuf field repeated string unreachable_locations = 3; * @return \Google\Protobuf\Internal\RepeatedField @@ -121,7 +121,7 @@ public function getUnreachableLocations() } /** - * Locations that could not be reached. + * Locations that the service couldn't reach. * * Generated from protobuf field repeated string unreachable_locations = 3; * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Dataplex/src/V1/ListEntryTypesRequest.php b/Dataplex/src/V1/ListEntryTypesRequest.php index 17dea956eb5f..e116070e65a1 100644 --- a/Dataplex/src/V1/ListEntryTypesRequest.php +++ b/Dataplex/src/V1/ListEntryTypesRequest.php @@ -18,15 +18,15 @@ class ListEntryTypesRequest extends \Google\Protobuf\Internal\Message /** * Required. The resource name of the EntryType location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $parent = ''; /** * Optional. Maximum number of EntryTypes to return. The service may return - * fewer than this value. If unspecified, at most 10 EntryTypes will be - * returned. The maximum value is 1000; values above 1000 will be coerced to + * fewer than this value. If unspecified, the service returns at most 10 + * EntryTypes. The maximum value is 1000; values above 1000 will be coerced to * 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -35,25 +35,25 @@ class ListEntryTypesRequest extends \Google\Protobuf\Internal\Message /** * Optional. Page token received from a previous `ListEntryTypes` call. * Provide this to retrieve the subsequent page. When paginating, all other - * parameters provided to `ListEntryTypes` must match the call that provided - * the page token. + * parameters you provided to `ListEntryTypes` must match the call that + * provided the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** * Optional. Filter request. Filters are case-sensitive. - * The following formats are supported: - * labels.key1 = "value1" - * labels:key1 - * name = "value" - * These restrictions can be coinjoined with AND, OR and NOT conjunctions. + * The service supports the following formats: + * * labels.key1 = "value1" + * * labels:key1 + * * name = "value" + * These restrictions can be conjoined with AND, OR, and NOT conjunctions. * * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $filter = ''; /** - * Optional. Order by fields (`name` or `create_time`) for the result. + * Optional. Orders the result by `name` or `create_time` fields. * If not specified, the ordering is undefined. * * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; @@ -63,7 +63,7 @@ class ListEntryTypesRequest extends \Google\Protobuf\Internal\Message /** * @param string $parent Required. The resource name of the EntryType location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. Please see + * where `location_id` refers to a Google Cloud region. Please see * {@see CatalogServiceClient::locationName()} for help formatting this field. * * @return \Google\Cloud\Dataplex\V1\ListEntryTypesRequest @@ -85,26 +85,26 @@ public static function build(string $parent): self * @type string $parent * Required. The resource name of the EntryType location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * @type int $page_size * Optional. Maximum number of EntryTypes to return. The service may return - * fewer than this value. If unspecified, at most 10 EntryTypes will be - * returned. The maximum value is 1000; values above 1000 will be coerced to + * fewer than this value. If unspecified, the service returns at most 10 + * EntryTypes. The maximum value is 1000; values above 1000 will be coerced to * 1000. * @type string $page_token * Optional. Page token received from a previous `ListEntryTypes` call. * Provide this to retrieve the subsequent page. When paginating, all other - * parameters provided to `ListEntryTypes` must match the call that provided - * the page token. + * parameters you provided to `ListEntryTypes` must match the call that + * provided the page token. * @type string $filter * Optional. Filter request. Filters are case-sensitive. - * The following formats are supported: - * labels.key1 = "value1" - * labels:key1 - * name = "value" - * These restrictions can be coinjoined with AND, OR and NOT conjunctions. + * The service supports the following formats: + * * labels.key1 = "value1" + * * labels:key1 + * * name = "value" + * These restrictions can be conjoined with AND, OR, and NOT conjunctions. * @type string $order_by - * Optional. Order by fields (`name` or `create_time`) for the result. + * Optional. Orders the result by `name` or `create_time` fields. * If not specified, the ordering is undefined. * } */ @@ -116,7 +116,7 @@ public function __construct($data = NULL) { /** * Required. The resource name of the EntryType location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string @@ -129,7 +129,7 @@ public function getParent() /** * Required. The resource name of the EntryType location, of the form: * `projects/{project_number}/locations/{location_id}` - * where `location_id` refers to a GCP region. + * where `location_id` refers to a Google Cloud region. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var @@ -145,8 +145,8 @@ public function setParent($var) /** * Optional. Maximum number of EntryTypes to return. The service may return - * fewer than this value. If unspecified, at most 10 EntryTypes will be - * returned. The maximum value is 1000; values above 1000 will be coerced to + * fewer than this value. If unspecified, the service returns at most 10 + * EntryTypes. The maximum value is 1000; values above 1000 will be coerced to * 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -159,8 +159,8 @@ public function getPageSize() /** * Optional. Maximum number of EntryTypes to return. The service may return - * fewer than this value. If unspecified, at most 10 EntryTypes will be - * returned. The maximum value is 1000; values above 1000 will be coerced to + * fewer than this value. If unspecified, the service returns at most 10 + * EntryTypes. The maximum value is 1000; values above 1000 will be coerced to * 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; @@ -178,8 +178,8 @@ public function setPageSize($var) /** * Optional. Page token received from a previous `ListEntryTypes` call. * Provide this to retrieve the subsequent page. When paginating, all other - * parameters provided to `ListEntryTypes` must match the call that provided - * the page token. + * parameters you provided to `ListEntryTypes` must match the call that + * provided the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -192,8 +192,8 @@ public function getPageToken() /** * Optional. Page token received from a previous `ListEntryTypes` call. * Provide this to retrieve the subsequent page. When paginating, all other - * parameters provided to `ListEntryTypes` must match the call that provided - * the page token. + * parameters you provided to `ListEntryTypes` must match the call that + * provided the page token. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -209,11 +209,11 @@ public function setPageToken($var) /** * Optional. Filter request. Filters are case-sensitive. - * The following formats are supported: - * labels.key1 = "value1" - * labels:key1 - * name = "value" - * These restrictions can be coinjoined with AND, OR and NOT conjunctions. + * The service supports the following formats: + * * labels.key1 = "value1" + * * labels:key1 + * * name = "value" + * These restrictions can be conjoined with AND, OR, and NOT conjunctions. * * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -225,11 +225,11 @@ public function getFilter() /** * Optional. Filter request. Filters are case-sensitive. - * The following formats are supported: - * labels.key1 = "value1" - * labels:key1 - * name = "value" - * These restrictions can be coinjoined with AND, OR and NOT conjunctions. + * The service supports the following formats: + * * labels.key1 = "value1" + * * labels:key1 + * * name = "value" + * These restrictions can be conjoined with AND, OR, and NOT conjunctions. * * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -244,7 +244,7 @@ public function setFilter($var) } /** - * Optional. Order by fields (`name` or `create_time`) for the result. + * Optional. Orders the result by `name` or `create_time` fields. * If not specified, the ordering is undefined. * * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; @@ -256,7 +256,7 @@ public function getOrderBy() } /** - * Optional. Order by fields (`name` or `create_time`) for the result. + * Optional. Orders the result by `name` or `create_time` fields. * If not specified, the ordering is undefined. * * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; diff --git a/Dataplex/src/V1/ListEntryTypesResponse.php b/Dataplex/src/V1/ListEntryTypesResponse.php index eb0289be361a..979b48e43f69 100644 --- a/Dataplex/src/V1/ListEntryTypesResponse.php +++ b/Dataplex/src/V1/ListEntryTypesResponse.php @@ -9,14 +9,14 @@ use Google\Protobuf\Internal\GPBUtil; /** - * List EntryTypes response + * List EntryTypes response. * * Generated from protobuf message google.cloud.dataplex.v1.ListEntryTypesResponse */ class ListEntryTypesResponse extends \Google\Protobuf\Internal\Message { /** - * ListEntryTypes under the given parent location. + * EntryTypes under the given parent location. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.EntryType entry_types = 1; */ @@ -29,7 +29,7 @@ class ListEntryTypesResponse extends \Google\Protobuf\Internal\Message */ protected $next_page_token = ''; /** - * Locations that could not be reached. + * Locations that the service couldn't reach. * * Generated from protobuf field repeated string unreachable_locations = 3; */ @@ -42,12 +42,12 @@ class ListEntryTypesResponse extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\Dataplex\V1\EntryType>|\Google\Protobuf\Internal\RepeatedField $entry_types - * ListEntryTypes under the given parent location. + * EntryTypes under the given parent location. * @type string $next_page_token * Token to retrieve the next page of results, or empty if there are no more * results in the list. * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable_locations - * Locations that could not be reached. + * Locations that the service couldn't reach. * } */ public function __construct($data = NULL) { @@ -56,7 +56,7 @@ public function __construct($data = NULL) { } /** - * ListEntryTypes under the given parent location. + * EntryTypes under the given parent location. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.EntryType entry_types = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -67,7 +67,7 @@ public function getEntryTypes() } /** - * ListEntryTypes under the given parent location. + * EntryTypes under the given parent location. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.EntryType entry_types = 1; * @param array<\Google\Cloud\Dataplex\V1\EntryType>|\Google\Protobuf\Internal\RepeatedField $var @@ -110,7 +110,7 @@ public function setNextPageToken($var) } /** - * Locations that could not be reached. + * Locations that the service couldn't reach. * * Generated from protobuf field repeated string unreachable_locations = 3; * @return \Google\Protobuf\Internal\RepeatedField @@ -121,7 +121,7 @@ public function getUnreachableLocations() } /** - * Locations that could not be reached. + * Locations that the service couldn't reach. * * Generated from protobuf field repeated string unreachable_locations = 3; * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Dataplex/src/V1/ListMetadataJobsRequest.php b/Dataplex/src/V1/ListMetadataJobsRequest.php new file mode 100644 index 000000000000..778b2d47c17d --- /dev/null +++ b/Dataplex/src/V1/ListMetadataJobsRequest.php @@ -0,0 +1,270 @@ +google.cloud.dataplex.v1.ListMetadataJobsRequest + */ +class ListMetadataJobsRequest extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The resource name of the parent location, in the format + * `projects/{project_id_or_number}/locations/{location_id}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + protected $parent = ''; + /** + * Optional. The maximum number of metadata jobs to return. The service might + * return fewer jobs than this value. If unspecified, at most 10 jobs are + * returned. The maximum value is 1,000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_size = 0; + /** + * Optional. The page token received from a previous `ListMetadataJobs` call. + * Provide this token to retrieve the subsequent page of results. When + * paginating, all other parameters that are provided to the + * `ListMetadataJobs` request must match the call that provided the page + * token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $page_token = ''; + /** + * Optional. Filter request. Filters are case-sensitive. + * The service supports the following formats: + * * `labels.key1 = "value1"` + * * `labels:key1` + * * `name = "value"` + * You can combine filters with `AND`, `OR`, and `NOT` operators. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $filter = ''; + /** + * Optional. The field to sort the results by, either `name` or `create_time`. + * If not specified, the ordering is undefined. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $order_by = ''; + + /** + * @param string $parent Required. The resource name of the parent location, in the format + * `projects/{project_id_or_number}/locations/{location_id}` + * Please see {@see CatalogServiceClient::locationName()} for help formatting this field. + * + * @return \Google\Cloud\Dataplex\V1\ListMetadataJobsRequest + * + * @experimental + */ + public static function build(string $parent): self + { + return (new self()) + ->setParent($parent); + } + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $parent + * Required. The resource name of the parent location, in the format + * `projects/{project_id_or_number}/locations/{location_id}` + * @type int $page_size + * Optional. The maximum number of metadata jobs to return. The service might + * return fewer jobs than this value. If unspecified, at most 10 jobs are + * returned. The maximum value is 1,000. + * @type string $page_token + * Optional. The page token received from a previous `ListMetadataJobs` call. + * Provide this token to retrieve the subsequent page of results. When + * paginating, all other parameters that are provided to the + * `ListMetadataJobs` request must match the call that provided the page + * token. + * @type string $filter + * Optional. Filter request. Filters are case-sensitive. + * The service supports the following formats: + * * `labels.key1 = "value1"` + * * `labels:key1` + * * `name = "value"` + * You can combine filters with `AND`, `OR`, and `NOT` operators. + * @type string $order_by + * Optional. The field to sort the results by, either `name` or `create_time`. + * If not specified, the ordering is undefined. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\Catalog::initOnce(); + parent::__construct($data); + } + + /** + * Required. The resource name of the parent location, in the format + * `projects/{project_id_or_number}/locations/{location_id}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return string + */ + public function getParent() + { + return $this->parent; + } + + /** + * Required. The resource name of the parent location, in the format + * `projects/{project_id_or_number}/locations/{location_id}` + * + * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param string $var + * @return $this + */ + public function setParent($var) + { + GPBUtil::checkString($var, True); + $this->parent = $var; + + return $this; + } + + /** + * Optional. The maximum number of metadata jobs to return. The service might + * return fewer jobs than this value. If unspecified, at most 10 jobs are + * returned. The maximum value is 1,000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getPageSize() + { + return $this->page_size; + } + + /** + * Optional. The maximum number of metadata jobs to return. The service might + * return fewer jobs than this value. If unspecified, at most 10 jobs are + * returned. The maximum value is 1,000. + * + * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setPageSize($var) + { + GPBUtil::checkInt32($var); + $this->page_size = $var; + + return $this; + } + + /** + * Optional. The page token received from a previous `ListMetadataJobs` call. + * Provide this token to retrieve the subsequent page of results. When + * paginating, all other parameters that are provided to the + * `ListMetadataJobs` request must match the call that provided the page + * token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getPageToken() + { + return $this->page_token; + } + + /** + * Optional. The page token received from a previous `ListMetadataJobs` call. + * Provide this token to retrieve the subsequent page of results. When + * paginating, all other parameters that are provided to the + * `ListMetadataJobs` request must match the call that provided the page + * token. + * + * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setPageToken($var) + { + GPBUtil::checkString($var, True); + $this->page_token = $var; + + return $this; + } + + /** + * Optional. Filter request. Filters are case-sensitive. + * The service supports the following formats: + * * `labels.key1 = "value1"` + * * `labels:key1` + * * `name = "value"` + * You can combine filters with `AND`, `OR`, and `NOT` operators. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Filter request. Filters are case-sensitive. + * The service supports the following formats: + * * `labels.key1 = "value1"` + * * `labels:key1` + * * `name = "value"` + * You can combine filters with `AND`, `OR`, and `NOT` operators. + * + * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. The field to sort the results by, either `name` or `create_time`. + * If not specified, the ordering is undefined. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. The field to sort the results by, either `name` or `create_time`. + * If not specified, the ordering is undefined. + * + * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + +} + diff --git a/Dataplex/src/V1/ListMetadataJobsResponse.php b/Dataplex/src/V1/ListMetadataJobsResponse.php new file mode 100644 index 000000000000..f6f79dddceaa --- /dev/null +++ b/Dataplex/src/V1/ListMetadataJobsResponse.php @@ -0,0 +1,139 @@ +google.cloud.dataplex.v1.ListMetadataJobsResponse + */ +class ListMetadataJobsResponse extends \Google\Protobuf\Internal\Message +{ + /** + * Metadata jobs under the specified parent location. + * + * Generated from protobuf field repeated .google.cloud.dataplex.v1.MetadataJob metadata_jobs = 1; + */ + private $metadata_jobs; + /** + * A token to retrieve the next page of results. If there are no more results + * in the list, the value is empty. + * + * Generated from protobuf field string next_page_token = 2; + */ + protected $next_page_token = ''; + /** + * Locations that the service couldn't reach. + * + * Generated from protobuf field repeated string unreachable_locations = 3; + */ + private $unreachable_locations; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\Dataplex\V1\MetadataJob>|\Google\Protobuf\Internal\RepeatedField $metadata_jobs + * Metadata jobs under the specified parent location. + * @type string $next_page_token + * A token to retrieve the next page of results. If there are no more results + * in the list, the value is empty. + * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable_locations + * Locations that the service couldn't reach. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\Catalog::initOnce(); + parent::__construct($data); + } + + /** + * Metadata jobs under the specified parent location. + * + * Generated from protobuf field repeated .google.cloud.dataplex.v1.MetadataJob metadata_jobs = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getMetadataJobs() + { + return $this->metadata_jobs; + } + + /** + * Metadata jobs under the specified parent location. + * + * Generated from protobuf field repeated .google.cloud.dataplex.v1.MetadataJob metadata_jobs = 1; + * @param array<\Google\Cloud\Dataplex\V1\MetadataJob>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setMetadataJobs($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Dataplex\V1\MetadataJob::class); + $this->metadata_jobs = $arr; + + return $this; + } + + /** + * A token to retrieve the next page of results. If there are no more results + * in the list, the value is empty. + * + * Generated from protobuf field string next_page_token = 2; + * @return string + */ + public function getNextPageToken() + { + return $this->next_page_token; + } + + /** + * A token to retrieve the next page of results. If there are no more results + * in the list, the value is empty. + * + * Generated from protobuf field string next_page_token = 2; + * @param string $var + * @return $this + */ + public function setNextPageToken($var) + { + GPBUtil::checkString($var, True); + $this->next_page_token = $var; + + return $this; + } + + /** + * Locations that the service couldn't reach. + * + * Generated from protobuf field repeated string unreachable_locations = 3; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getUnreachableLocations() + { + return $this->unreachable_locations; + } + + /** + * Locations that the service couldn't reach. + * + * Generated from protobuf field repeated string unreachable_locations = 3; + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setUnreachableLocations($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->unreachable_locations = $arr; + + return $this; + } + +} + diff --git a/Dataplex/src/V1/LookupEntryRequest.php b/Dataplex/src/V1/LookupEntryRequest.php index c472298bbafb..a44150e8c591 100644 --- a/Dataplex/src/V1/LookupEntryRequest.php +++ b/Dataplex/src/V1/LookupEntryRequest.php @@ -9,6 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** + * Lookup Entry request using permissions in the source system. + * * Generated from protobuf message google.cloud.dataplex.v1.LookupEntryRequest */ class LookupEntryRequest extends \Google\Protobuf\Internal\Message @@ -21,21 +23,22 @@ class LookupEntryRequest extends \Google\Protobuf\Internal\Message */ protected $name = ''; /** - * Optional. View for controlling which parts of an entry are to be returned. + * Optional. View to control which parts of an entry the service should + * return. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryView view = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $view = 0; /** * Optional. Limits the aspects returned to the provided aspect types. - * Only works if the CUSTOM view is selected. + * It only works for CUSTOM view. * * Generated from protobuf field repeated string aspect_types = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $aspect_types; /** * Optional. Limits the aspects returned to those associated with the provided - * paths within the Entry. Only works if the CUSTOM view is selected. + * paths within the Entry. It only works for CUSTOM view. * * Generated from protobuf field repeated string paths = 4 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -58,13 +61,14 @@ class LookupEntryRequest extends \Google\Protobuf\Internal\Message * Required. The project to which the request should be attributed in the * following form: `projects/{project}/locations/{location}`. * @type int $view - * Optional. View for controlling which parts of an entry are to be returned. + * Optional. View to control which parts of an entry the service should + * return. * @type array|\Google\Protobuf\Internal\RepeatedField $aspect_types * Optional. Limits the aspects returned to the provided aspect types. - * Only works if the CUSTOM view is selected. + * It only works for CUSTOM view. * @type array|\Google\Protobuf\Internal\RepeatedField $paths * Optional. Limits the aspects returned to those associated with the provided - * paths within the Entry. Only works if the CUSTOM view is selected. + * paths within the Entry. It only works for CUSTOM view. * @type string $entry * Required. The resource name of the Entry: * `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`. @@ -104,7 +108,8 @@ public function setName($var) } /** - * Optional. View for controlling which parts of an entry are to be returned. + * Optional. View to control which parts of an entry the service should + * return. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryView view = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -115,7 +120,8 @@ public function getView() } /** - * Optional. View for controlling which parts of an entry are to be returned. + * Optional. View to control which parts of an entry the service should + * return. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryView view = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var @@ -131,7 +137,7 @@ public function setView($var) /** * Optional. Limits the aspects returned to the provided aspect types. - * Only works if the CUSTOM view is selected. + * It only works for CUSTOM view. * * Generated from protobuf field repeated string aspect_types = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField @@ -143,7 +149,7 @@ public function getAspectTypes() /** * Optional. Limits the aspects returned to the provided aspect types. - * Only works if the CUSTOM view is selected. + * It only works for CUSTOM view. * * Generated from protobuf field repeated string aspect_types = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var @@ -159,7 +165,7 @@ public function setAspectTypes($var) /** * Optional. Limits the aspects returned to those associated with the provided - * paths within the Entry. Only works if the CUSTOM view is selected. + * paths within the Entry. It only works for CUSTOM view. * * Generated from protobuf field repeated string paths = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField @@ -171,7 +177,7 @@ public function getPaths() /** * Optional. Limits the aspects returned to those associated with the provided - * paths within the Entry. Only works if the CUSTOM view is selected. + * paths within the Entry. It only works for CUSTOM view. * * Generated from protobuf field repeated string paths = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Dataplex/src/V1/MetadataJob.php b/Dataplex/src/V1/MetadataJob.php new file mode 100644 index 000000000000..d52051509271 --- /dev/null +++ b/Dataplex/src/V1/MetadataJob.php @@ -0,0 +1,401 @@ +google.cloud.dataplex.v1.MetadataJob + */ +class MetadataJob extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. Identifier. The name of the resource that the configuration is + * applied to, in the format + * `projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; + */ + protected $name = ''; + /** + * Output only. A system-generated, globally unique ID for the metadata job. + * If the metadata job is deleted and then re-created with the same name, this + * ID is different. + * + * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + */ + protected $uid = ''; + /** + * Output only. The time when the metadata job was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $create_time = null; + /** + * Output only. The time when the metadata job was updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + /** + * Optional. User-defined labels. + * + * Generated from protobuf field map labels = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $labels; + /** + * Required. Metadata job type. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.Type type = 6 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $type = 0; + /** + * Output only. Metadata job status. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.Status status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $status = null; + protected $spec; + protected $result; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $name + * Output only. Identifier. The name of the resource that the configuration is + * applied to, in the format + * `projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`. + * @type string $uid + * Output only. A system-generated, globally unique ID for the metadata job. + * If the metadata job is deleted and then re-created with the same name, this + * ID is different. + * @type \Google\Protobuf\Timestamp $create_time + * Output only. The time when the metadata job was created. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The time when the metadata job was updated. + * @type array|\Google\Protobuf\Internal\MapField $labels + * Optional. User-defined labels. + * @type int $type + * Required. Metadata job type. + * @type \Google\Cloud\Dataplex\V1\MetadataJob\ImportJobSpec $import_spec + * Import job specification. + * @type \Google\Cloud\Dataplex\V1\MetadataJob\ImportJobResult $import_result + * Output only. Import job result. + * @type \Google\Cloud\Dataplex\V1\MetadataJob\Status $status + * Output only. Metadata job status. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\Catalog::initOnce(); + parent::__construct($data); + } + + /** + * Output only. Identifier. The name of the resource that the configuration is + * applied to, in the format + * `projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * Output only. Identifier. The name of the resource that the configuration is + * applied to, in the format + * `projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`. + * + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER]; + * @param string $var + * @return $this + */ + public function setName($var) + { + GPBUtil::checkString($var, True); + $this->name = $var; + + return $this; + } + + /** + * Output only. A system-generated, globally unique ID for the metadata job. + * If the metadata job is deleted and then re-created with the same name, this + * ID is different. + * + * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + * @return string + */ + public function getUid() + { + return $this->uid; + } + + /** + * Output only. A system-generated, globally unique ID for the metadata job. + * If the metadata job is deleted and then re-created with the same name, this + * ID is different. + * + * Generated from protobuf field string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { + * @param string $var + * @return $this + */ + public function setUid($var) + { + GPBUtil::checkString($var, True); + $this->uid = $var; + + return $this; + } + + /** + * Output only. The time when the metadata job was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getCreateTime() + { + return $this->create_time; + } + + public function hasCreateTime() + { + return isset($this->create_time); + } + + public function clearCreateTime() + { + unset($this->create_time); + } + + /** + * Output only. The time when the metadata job was created. + * + * Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->create_time = $var; + + return $this; + } + + /** + * Output only. The time when the metadata job was updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The time when the metadata job was updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + + /** + * Optional. User-defined labels. + * + * Generated from protobuf field map labels = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Internal\MapField + */ + public function getLabels() + { + return $this->labels; + } + + /** + * Optional. User-defined labels. + * + * Generated from protobuf field map labels = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->labels = $arr; + + return $this; + } + + /** + * Required. Metadata job type. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.Type type = 6 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getType() + { + return $this->type; + } + + /** + * Required. Metadata job type. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.Type type = 6 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Dataplex\V1\MetadataJob\Type::class); + $this->type = $var; + + return $this; + } + + /** + * Import job specification. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec import_spec = 100; + * @return \Google\Cloud\Dataplex\V1\MetadataJob\ImportJobSpec|null + */ + public function getImportSpec() + { + return $this->readOneof(100); + } + + public function hasImportSpec() + { + return $this->hasOneof(100); + } + + /** + * Import job specification. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec import_spec = 100; + * @param \Google\Cloud\Dataplex\V1\MetadataJob\ImportJobSpec $var + * @return $this + */ + public function setImportSpec($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\MetadataJob\ImportJobSpec::class); + $this->writeOneof(100, $var); + + return $this; + } + + /** + * Output only. Import job result. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobResult import_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\Dataplex\V1\MetadataJob\ImportJobResult|null + */ + public function getImportResult() + { + return $this->readOneof(200); + } + + public function hasImportResult() + { + return $this->hasOneof(200); + } + + /** + * Output only. Import job result. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobResult import_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\Dataplex\V1\MetadataJob\ImportJobResult $var + * @return $this + */ + public function setImportResult($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\MetadataJob\ImportJobResult::class); + $this->writeOneof(200, $var); + + return $this; + } + + /** + * Output only. Metadata job status. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.Status status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\Dataplex\V1\MetadataJob\Status|null + */ + public function getStatus() + { + return $this->status; + } + + public function hasStatus() + { + return isset($this->status); + } + + public function clearStatus() + { + unset($this->status); + } + + /** + * Output only. Metadata job status. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.Status status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\Dataplex\V1\MetadataJob\Status $var + * @return $this + */ + public function setStatus($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\MetadataJob\Status::class); + $this->status = $var; + + return $this; + } + + /** + * @return string + */ + public function getSpec() + { + return $this->whichOneof("spec"); + } + + /** + * @return string + */ + public function getResult() + { + return $this->whichOneof("result"); + } + +} + diff --git a/Dataplex/src/V1/MetadataJob/ImportJobResult.php b/Dataplex/src/V1/MetadataJob/ImportJobResult.php new file mode 100644 index 000000000000..0b79cc478d3f --- /dev/null +++ b/Dataplex/src/V1/MetadataJob/ImportJobResult.php @@ -0,0 +1,248 @@ +google.cloud.dataplex.v1.MetadataJob.ImportJobResult + */ +class ImportJobResult extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. The total number of entries that were deleted. + * + * Generated from protobuf field int64 deleted_entries = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $deleted_entries = 0; + /** + * Output only. The total number of entries that were updated. + * + * Generated from protobuf field int64 updated_entries = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $updated_entries = 0; + /** + * Output only. The total number of entries that were created. + * + * Generated from protobuf field int64 created_entries = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $created_entries = 0; + /** + * Output only. The total number of entries that were unchanged. + * + * Generated from protobuf field int64 unchanged_entries = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $unchanged_entries = 0; + /** + * Output only. The total number of entries that were recreated. + * + * Generated from protobuf field int64 recreated_entries = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $recreated_entries = 0; + /** + * Output only. The time when the status was updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int|string $deleted_entries + * Output only. The total number of entries that were deleted. + * @type int|string $updated_entries + * Output only. The total number of entries that were updated. + * @type int|string $created_entries + * Output only. The total number of entries that were created. + * @type int|string $unchanged_entries + * Output only. The total number of entries that were unchanged. + * @type int|string $recreated_entries + * Output only. The total number of entries that were recreated. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The time when the status was updated. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\Catalog::initOnce(); + parent::__construct($data); + } + + /** + * Output only. The total number of entries that were deleted. + * + * Generated from protobuf field int64 deleted_entries = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getDeletedEntries() + { + return $this->deleted_entries; + } + + /** + * Output only. The total number of entries that were deleted. + * + * Generated from protobuf field int64 deleted_entries = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setDeletedEntries($var) + { + GPBUtil::checkInt64($var); + $this->deleted_entries = $var; + + return $this; + } + + /** + * Output only. The total number of entries that were updated. + * + * Generated from protobuf field int64 updated_entries = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getUpdatedEntries() + { + return $this->updated_entries; + } + + /** + * Output only. The total number of entries that were updated. + * + * Generated from protobuf field int64 updated_entries = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setUpdatedEntries($var) + { + GPBUtil::checkInt64($var); + $this->updated_entries = $var; + + return $this; + } + + /** + * Output only. The total number of entries that were created. + * + * Generated from protobuf field int64 created_entries = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getCreatedEntries() + { + return $this->created_entries; + } + + /** + * Output only. The total number of entries that were created. + * + * Generated from protobuf field int64 created_entries = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setCreatedEntries($var) + { + GPBUtil::checkInt64($var); + $this->created_entries = $var; + + return $this; + } + + /** + * Output only. The total number of entries that were unchanged. + * + * Generated from protobuf field int64 unchanged_entries = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getUnchangedEntries() + { + return $this->unchanged_entries; + } + + /** + * Output only. The total number of entries that were unchanged. + * + * Generated from protobuf field int64 unchanged_entries = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setUnchangedEntries($var) + { + GPBUtil::checkInt64($var); + $this->unchanged_entries = $var; + + return $this; + } + + /** + * Output only. The total number of entries that were recreated. + * + * Generated from protobuf field int64 recreated_entries = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int|string + */ + public function getRecreatedEntries() + { + return $this->recreated_entries; + } + + /** + * Output only. The total number of entries that were recreated. + * + * Generated from protobuf field int64 recreated_entries = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int|string $var + * @return $this + */ + public function setRecreatedEntries($var) + { + GPBUtil::checkInt64($var); + $this->recreated_entries = $var; + + return $this; + } + + /** + * Output only. The time when the status was updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The time when the status was updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + +} + + diff --git a/Dataplex/src/V1/MetadataJob/ImportJobSpec.php b/Dataplex/src/V1/MetadataJob/ImportJobSpec.php new file mode 100644 index 000000000000..33239c9ecf47 --- /dev/null +++ b/Dataplex/src/V1/MetadataJob/ImportJobSpec.php @@ -0,0 +1,362 @@ +google.cloud.dataplex.v1.MetadataJob.ImportJobSpec + */ +class ImportJobSpec extends \Google\Protobuf\Internal\Message +{ + /** + * Optional. The URI of a Cloud Storage bucket or folder (beginning with + * `gs://` and ending with `/`) that contains the metadata import files for + * this job. + * A metadata import file defines the values to set for each of the entries + * and aspects in a metadata job. For more information about how to create a + * metadata import file and the file requirements, see [Metadata import + * file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file). + * You can provide multiple metadata import files in the same metadata job. + * The bucket or folder must contain at least one metadata import file, in + * JSON Lines format (either `.json` or `.jsonl` file extension). + * In `FULL` entry sync mode, don't save the metadata import file in a + * folder named `SOURCE_STORAGE_URI/deletions/`. + * **Caution**: If the metadata import file contains no data, all entries + * and aspects that belong to the job's scope are deleted. + * + * Generated from protobuf field string source_storage_uri = 1 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $source_storage_uri = ''; + /** + * Optional. The time when the process that created the metadata import + * files began. + * + * Generated from protobuf field .google.protobuf.Timestamp source_create_time = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $source_create_time = null; + /** + * Required. A boundary on the scope of impact that the metadata import job + * can have. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.ImportJobScope scope = 2 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $scope = null; + /** + * Required. The sync mode for entries. + * Only `FULL` mode is supported for entries. All entries in the job's scope + * are modified. If an entry exists in Dataplex but isn't included in the + * metadata import file, the entry is deleted when you run the metadata job. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode entry_sync_mode = 3 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $entry_sync_mode = 0; + /** + * Required. The sync mode for aspects. + * Only `INCREMENTAL` mode is supported for aspects. An aspect is modified + * only if the metadata import file includes a reference to the aspect in + * the `update_mask` field and the `aspect_keys` field. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode aspect_sync_mode = 4 [(.google.api.field_behavior) = REQUIRED]; + */ + protected $aspect_sync_mode = 0; + /** + * Optional. The level of logs to write to Cloud Logging for this job. + * Debug-level logs provide highly-detailed information for + * troubleshooting, but their increased verbosity could incur [additional + * costs](https://cloud.google.com/stackdriver/pricing) that might not be + * merited for all jobs. + * If unspecified, defaults to `INFO`. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.LogLevel log_level = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + protected $log_level = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $source_storage_uri + * Optional. The URI of a Cloud Storage bucket or folder (beginning with + * `gs://` and ending with `/`) that contains the metadata import files for + * this job. + * A metadata import file defines the values to set for each of the entries + * and aspects in a metadata job. For more information about how to create a + * metadata import file and the file requirements, see [Metadata import + * file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file). + * You can provide multiple metadata import files in the same metadata job. + * The bucket or folder must contain at least one metadata import file, in + * JSON Lines format (either `.json` or `.jsonl` file extension). + * In `FULL` entry sync mode, don't save the metadata import file in a + * folder named `SOURCE_STORAGE_URI/deletions/`. + * **Caution**: If the metadata import file contains no data, all entries + * and aspects that belong to the job's scope are deleted. + * @type \Google\Protobuf\Timestamp $source_create_time + * Optional. The time when the process that created the metadata import + * files began. + * @type \Google\Cloud\Dataplex\V1\MetadataJob\ImportJobSpec\ImportJobScope $scope + * Required. A boundary on the scope of impact that the metadata import job + * can have. + * @type int $entry_sync_mode + * Required. The sync mode for entries. + * Only `FULL` mode is supported for entries. All entries in the job's scope + * are modified. If an entry exists in Dataplex but isn't included in the + * metadata import file, the entry is deleted when you run the metadata job. + * @type int $aspect_sync_mode + * Required. The sync mode for aspects. + * Only `INCREMENTAL` mode is supported for aspects. An aspect is modified + * only if the metadata import file includes a reference to the aspect in + * the `update_mask` field and the `aspect_keys` field. + * @type int $log_level + * Optional. The level of logs to write to Cloud Logging for this job. + * Debug-level logs provide highly-detailed information for + * troubleshooting, but their increased verbosity could incur [additional + * costs](https://cloud.google.com/stackdriver/pricing) that might not be + * merited for all jobs. + * If unspecified, defaults to `INFO`. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\Catalog::initOnce(); + parent::__construct($data); + } + + /** + * Optional. The URI of a Cloud Storage bucket or folder (beginning with + * `gs://` and ending with `/`) that contains the metadata import files for + * this job. + * A metadata import file defines the values to set for each of the entries + * and aspects in a metadata job. For more information about how to create a + * metadata import file and the file requirements, see [Metadata import + * file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file). + * You can provide multiple metadata import files in the same metadata job. + * The bucket or folder must contain at least one metadata import file, in + * JSON Lines format (either `.json` or `.jsonl` file extension). + * In `FULL` entry sync mode, don't save the metadata import file in a + * folder named `SOURCE_STORAGE_URI/deletions/`. + * **Caution**: If the metadata import file contains no data, all entries + * and aspects that belong to the job's scope are deleted. + * + * Generated from protobuf field string source_storage_uri = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getSourceStorageUri() + { + return $this->source_storage_uri; + } + + /** + * Optional. The URI of a Cloud Storage bucket or folder (beginning with + * `gs://` and ending with `/`) that contains the metadata import files for + * this job. + * A metadata import file defines the values to set for each of the entries + * and aspects in a metadata job. For more information about how to create a + * metadata import file and the file requirements, see [Metadata import + * file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file). + * You can provide multiple metadata import files in the same metadata job. + * The bucket or folder must contain at least one metadata import file, in + * JSON Lines format (either `.json` or `.jsonl` file extension). + * In `FULL` entry sync mode, don't save the metadata import file in a + * folder named `SOURCE_STORAGE_URI/deletions/`. + * **Caution**: If the metadata import file contains no data, all entries + * and aspects that belong to the job's scope are deleted. + * + * Generated from protobuf field string source_storage_uri = 1 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setSourceStorageUri($var) + { + GPBUtil::checkString($var, True); + $this->source_storage_uri = $var; + + return $this; + } + + /** + * Optional. The time when the process that created the metadata import + * files began. + * + * Generated from protobuf field .google.protobuf.Timestamp source_create_time = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getSourceCreateTime() + { + return $this->source_create_time; + } + + public function hasSourceCreateTime() + { + return isset($this->source_create_time); + } + + public function clearSourceCreateTime() + { + unset($this->source_create_time); + } + + /** + * Optional. The time when the process that created the metadata import + * files began. + * + * Generated from protobuf field .google.protobuf.Timestamp source_create_time = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setSourceCreateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->source_create_time = $var; + + return $this; + } + + /** + * Required. A boundary on the scope of impact that the metadata import job + * can have. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.ImportJobScope scope = 2 [(.google.api.field_behavior) = REQUIRED]; + * @return \Google\Cloud\Dataplex\V1\MetadataJob\ImportJobSpec\ImportJobScope|null + */ + public function getScope() + { + return $this->scope; + } + + public function hasScope() + { + return isset($this->scope); + } + + public function clearScope() + { + unset($this->scope); + } + + /** + * Required. A boundary on the scope of impact that the metadata import job + * can have. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.ImportJobScope scope = 2 [(.google.api.field_behavior) = REQUIRED]; + * @param \Google\Cloud\Dataplex\V1\MetadataJob\ImportJobSpec\ImportJobScope $var + * @return $this + */ + public function setScope($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\MetadataJob\ImportJobSpec\ImportJobScope::class); + $this->scope = $var; + + return $this; + } + + /** + * Required. The sync mode for entries. + * Only `FULL` mode is supported for entries. All entries in the job's scope + * are modified. If an entry exists in Dataplex but isn't included in the + * metadata import file, the entry is deleted when you run the metadata job. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode entry_sync_mode = 3 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getEntrySyncMode() + { + return $this->entry_sync_mode; + } + + /** + * Required. The sync mode for entries. + * Only `FULL` mode is supported for entries. All entries in the job's scope + * are modified. If an entry exists in Dataplex but isn't included in the + * metadata import file, the entry is deleted when you run the metadata job. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode entry_sync_mode = 3 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setEntrySyncMode($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Dataplex\V1\MetadataJob\ImportJobSpec\SyncMode::class); + $this->entry_sync_mode = $var; + + return $this; + } + + /** + * Required. The sync mode for aspects. + * Only `INCREMENTAL` mode is supported for aspects. An aspect is modified + * only if the metadata import file includes a reference to the aspect in + * the `update_mask` field and the `aspect_keys` field. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode aspect_sync_mode = 4 [(.google.api.field_behavior) = REQUIRED]; + * @return int + */ + public function getAspectSyncMode() + { + return $this->aspect_sync_mode; + } + + /** + * Required. The sync mode for aspects. + * Only `INCREMENTAL` mode is supported for aspects. An aspect is modified + * only if the metadata import file includes a reference to the aspect in + * the `update_mask` field and the `aspect_keys` field. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode aspect_sync_mode = 4 [(.google.api.field_behavior) = REQUIRED]; + * @param int $var + * @return $this + */ + public function setAspectSyncMode($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Dataplex\V1\MetadataJob\ImportJobSpec\SyncMode::class); + $this->aspect_sync_mode = $var; + + return $this; + } + + /** + * Optional. The level of logs to write to Cloud Logging for this job. + * Debug-level logs provide highly-detailed information for + * troubleshooting, but their increased verbosity could incur [additional + * costs](https://cloud.google.com/stackdriver/pricing) that might not be + * merited for all jobs. + * If unspecified, defaults to `INFO`. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.LogLevel log_level = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return int + */ + public function getLogLevel() + { + return $this->log_level; + } + + /** + * Optional. The level of logs to write to Cloud Logging for this job. + * Debug-level logs provide highly-detailed information for + * troubleshooting, but their increased verbosity could incur [additional + * costs](https://cloud.google.com/stackdriver/pricing) that might not be + * merited for all jobs. + * If unspecified, defaults to `INFO`. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.LogLevel log_level = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param int $var + * @return $this + */ + public function setLogLevel($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Dataplex\V1\MetadataJob\ImportJobSpec\LogLevel::class); + $this->log_level = $var; + + return $this; + } + +} + + diff --git a/Dataplex/src/V1/MetadataJob/ImportJobSpec/ImportJobScope.php b/Dataplex/src/V1/MetadataJob/ImportJobSpec/ImportJobScope.php new file mode 100644 index 000000000000..0079b2835bc3 --- /dev/null +++ b/Dataplex/src/V1/MetadataJob/ImportJobSpec/ImportJobScope.php @@ -0,0 +1,224 @@ +google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.ImportJobScope + */ +class ImportJobScope extends \Google\Protobuf\Internal\Message +{ + /** + * Required. The entry group that is in scope for the import job, + * specified as a relative resource name in the format + * `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`. + * Only entries that belong to the specified entry group are affected by + * the job. + * Must contain exactly one element. The entry group and the job + * must be in the same location. + * + * Generated from protobuf field repeated string entry_groups = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + private $entry_groups; + /** + * Required. The entry types that are in scope for the import job, + * specified as relative resource names in the format + * `projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}`. + * The job modifies only the entries that belong to these entry types. + * If the metadata import file attempts to modify an entry whose type + * isn't included in this list, the import job is halted before modifying + * any entries or aspects. + * The location of an entry type must either match the location of the + * job, or the entry type must be global. + * + * Generated from protobuf field repeated string entry_types = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + */ + private $entry_types; + /** + * Optional. The aspect types that are in scope for the import job, + * specified as relative resource names in the format + * `projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}`. + * The job modifies only the aspects that belong to these aspect types. + * If the metadata import file attempts to modify an aspect whose type + * isn't included in this list, the import job is halted before modifying + * any entries or aspects. + * The location of an aspect type must either match the location of the + * job, or the aspect type must be global. + * + * Generated from protobuf field repeated string aspect_types = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + */ + private $aspect_types; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array|\Google\Protobuf\Internal\RepeatedField $entry_groups + * Required. The entry group that is in scope for the import job, + * specified as a relative resource name in the format + * `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`. + * Only entries that belong to the specified entry group are affected by + * the job. + * Must contain exactly one element. The entry group and the job + * must be in the same location. + * @type array|\Google\Protobuf\Internal\RepeatedField $entry_types + * Required. The entry types that are in scope for the import job, + * specified as relative resource names in the format + * `projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}`. + * The job modifies only the entries that belong to these entry types. + * If the metadata import file attempts to modify an entry whose type + * isn't included in this list, the import job is halted before modifying + * any entries or aspects. + * The location of an entry type must either match the location of the + * job, or the entry type must be global. + * @type array|\Google\Protobuf\Internal\RepeatedField $aspect_types + * Optional. The aspect types that are in scope for the import job, + * specified as relative resource names in the format + * `projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}`. + * The job modifies only the aspects that belong to these aspect types. + * If the metadata import file attempts to modify an aspect whose type + * isn't included in this list, the import job is halted before modifying + * any entries or aspects. + * The location of an aspect type must either match the location of the + * job, or the aspect type must be global. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\Catalog::initOnce(); + parent::__construct($data); + } + + /** + * Required. The entry group that is in scope for the import job, + * specified as a relative resource name in the format + * `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`. + * Only entries that belong to the specified entry group are affected by + * the job. + * Must contain exactly one element. The entry group and the job + * must be in the same location. + * + * Generated from protobuf field repeated string entry_groups = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getEntryGroups() + { + return $this->entry_groups; + } + + /** + * Required. The entry group that is in scope for the import job, + * specified as a relative resource name in the format + * `projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}`. + * Only entries that belong to the specified entry group are affected by + * the job. + * Must contain exactly one element. The entry group and the job + * must be in the same location. + * + * Generated from protobuf field repeated string entry_groups = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setEntryGroups($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->entry_groups = $arr; + + return $this; + } + + /** + * Required. The entry types that are in scope for the import job, + * specified as relative resource names in the format + * `projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}`. + * The job modifies only the entries that belong to these entry types. + * If the metadata import file attempts to modify an entry whose type + * isn't included in this list, the import job is halted before modifying + * any entries or aspects. + * The location of an entry type must either match the location of the + * job, or the entry type must be global. + * + * Generated from protobuf field repeated string entry_types = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getEntryTypes() + { + return $this->entry_types; + } + + /** + * Required. The entry types that are in scope for the import job, + * specified as relative resource names in the format + * `projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}`. + * The job modifies only the entries that belong to these entry types. + * If the metadata import file attempts to modify an entry whose type + * isn't included in this list, the import job is halted before modifying + * any entries or aspects. + * The location of an entry type must either match the location of the + * job, or the entry type must be global. + * + * Generated from protobuf field repeated string entry_types = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setEntryTypes($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->entry_types = $arr; + + return $this; + } + + /** + * Optional. The aspect types that are in scope for the import job, + * specified as relative resource names in the format + * `projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}`. + * The job modifies only the aspects that belong to these aspect types. + * If the metadata import file attempts to modify an aspect whose type + * isn't included in this list, the import job is halted before modifying + * any entries or aspects. + * The location of an aspect type must either match the location of the + * job, or the aspect type must be global. + * + * Generated from protobuf field repeated string aspect_types = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getAspectTypes() + { + return $this->aspect_types; + } + + /** + * Optional. The aspect types that are in scope for the import job, + * specified as relative resource names in the format + * `projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}`. + * The job modifies only the aspects that belong to these aspect types. + * If the metadata import file attempts to modify an aspect whose type + * isn't included in this list, the import job is halted before modifying + * any entries or aspects. + * The location of an aspect type must either match the location of the + * job, or the aspect type must be global. + * + * Generated from protobuf field repeated string aspect_types = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { + * @param array|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setAspectTypes($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); + $this->aspect_types = $arr; + + return $this; + } + +} + + diff --git a/Dataplex/src/V1/MetadataJob/ImportJobSpec/LogLevel.php b/Dataplex/src/V1/MetadataJob/ImportJobSpec/LogLevel.php new file mode 100644 index 000000000000..97092f9ee3fc --- /dev/null +++ b/Dataplex/src/V1/MetadataJob/ImportJobSpec/LogLevel.php @@ -0,0 +1,72 @@ +google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.LogLevel + */ +class LogLevel +{ + /** + * Log level unspecified. + * + * Generated from protobuf enum LOG_LEVEL_UNSPECIFIED = 0; + */ + const LOG_LEVEL_UNSPECIFIED = 0; + /** + * Debug-level logging. Captures detailed logs for each import item. Use + * debug-level logging to troubleshoot issues with specific import items. + * For example, use debug-level logging to identify resources that are + * missing from the job scope, entries or aspects that don't conform to + * the associated entry type or aspect type, or other misconfigurations + * with the metadata import file. + * Depending on the size of your metadata job and the number of logs that + * are generated, debug-level logging might incur + * [additional costs](https://cloud.google.com/stackdriver/pricing). + * + * Generated from protobuf enum DEBUG = 1; + */ + const DEBUG = 1; + /** + * Info-level logging. Captures logs at the overall job level. Includes + * aggregate logs about import items, but doesn't specify which import + * item has an error. + * + * Generated from protobuf enum INFO = 2; + */ + const INFO = 2; + + private static $valueToName = [ + self::LOG_LEVEL_UNSPECIFIED => 'LOG_LEVEL_UNSPECIFIED', + self::DEBUG => 'DEBUG', + self::INFO => 'INFO', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Dataplex/src/V1/MetadataJob/ImportJobSpec/SyncMode.php b/Dataplex/src/V1/MetadataJob/ImportJobSpec/SyncMode.php new file mode 100644 index 000000000000..cefedba1cc04 --- /dev/null +++ b/Dataplex/src/V1/MetadataJob/ImportJobSpec/SyncMode.php @@ -0,0 +1,67 @@ +google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode + */ +class SyncMode +{ + /** + * Sync mode unspecified. + * + * Generated from protobuf enum SYNC_MODE_UNSPECIFIED = 0; + */ + const SYNC_MODE_UNSPECIFIED = 0; + /** + * All resources in the job's scope are modified. If a resource exists in + * Dataplex but isn't included in the metadata import file, the resource + * is deleted when you run the metadata job. Use this mode to perform a + * full sync of the set of entries in the job scope. + * + * Generated from protobuf enum FULL = 1; + */ + const FULL = 1; + /** + * Only the entries and aspects that are explicitly included in the + * metadata import file are modified. Use this mode to modify a subset of + * resources while leaving unreferenced resources unchanged. + * + * Generated from protobuf enum INCREMENTAL = 2; + */ + const INCREMENTAL = 2; + + private static $valueToName = [ + self::SYNC_MODE_UNSPECIFIED => 'SYNC_MODE_UNSPECIFIED', + self::FULL => 'FULL', + self::INCREMENTAL => 'INCREMENTAL', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Dataplex/src/V1/MetadataJob/Status.php b/Dataplex/src/V1/MetadataJob/Status.php new file mode 100644 index 000000000000..df85a48ac2db --- /dev/null +++ b/Dataplex/src/V1/MetadataJob/Status.php @@ -0,0 +1,180 @@ +google.cloud.dataplex.v1.MetadataJob.Status + */ +class Status extends \Google\Protobuf\Internal\Message +{ + /** + * Output only. State of the metadata job. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.Status.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $state = 0; + /** + * Output only. Message relating to the progression of a metadata job. + * + * Generated from protobuf field string message = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $message = ''; + /** + * Output only. Progress tracking. + * + * Generated from protobuf field int32 completion_percent = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $completion_percent = 0; + /** + * Output only. The time when the status was updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $update_time = null; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type int $state + * Output only. State of the metadata job. + * @type string $message + * Output only. Message relating to the progression of a metadata job. + * @type int $completion_percent + * Output only. Progress tracking. + * @type \Google\Protobuf\Timestamp $update_time + * Output only. The time when the status was updated. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Dataplex\V1\Catalog::initOnce(); + parent::__construct($data); + } + + /** + * Output only. State of the metadata job. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.Status.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getState() + { + return $this->state; + } + + /** + * Output only. State of the metadata job. + * + * Generated from protobuf field .google.cloud.dataplex.v1.MetadataJob.Status.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setState($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Dataplex\V1\MetadataJob\Status\State::class); + $this->state = $var; + + return $this; + } + + /** + * Output only. Message relating to the progression of a metadata job. + * + * Generated from protobuf field string message = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getMessage() + { + return $this->message; + } + + /** + * Output only. Message relating to the progression of a metadata job. + * + * Generated from protobuf field string message = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setMessage($var) + { + GPBUtil::checkString($var, True); + $this->message = $var; + + return $this; + } + + /** + * Output only. Progress tracking. + * + * Generated from protobuf field int32 completion_percent = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return int + */ + public function getCompletionPercent() + { + return $this->completion_percent; + } + + /** + * Output only. Progress tracking. + * + * Generated from protobuf field int32 completion_percent = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param int $var + * @return $this + */ + public function setCompletionPercent($var) + { + GPBUtil::checkInt32($var); + $this->completion_percent = $var; + + return $this; + } + + /** + * Output only. The time when the status was updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Timestamp|null + */ + public function getUpdateTime() + { + return $this->update_time; + } + + public function hasUpdateTime() + { + return isset($this->update_time); + } + + public function clearUpdateTime() + { + unset($this->update_time); + } + + /** + * Output only. The time when the status was updated. + * + * Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Timestamp $var + * @return $this + */ + public function setUpdateTime($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); + $this->update_time = $var; + + return $this; + } + +} + + diff --git a/Dataplex/src/V1/MetadataJob/Status/State.php b/Dataplex/src/V1/MetadataJob/Status/State.php new file mode 100644 index 000000000000..29b6070b195a --- /dev/null +++ b/Dataplex/src/V1/MetadataJob/Status/State.php @@ -0,0 +1,97 @@ +google.cloud.dataplex.v1.MetadataJob.Status.State + */ +class State +{ + /** + * State unspecified. + * + * Generated from protobuf enum STATE_UNSPECIFIED = 0; + */ + const STATE_UNSPECIFIED = 0; + /** + * The job is queued. + * + * Generated from protobuf enum QUEUED = 1; + */ + const QUEUED = 1; + /** + * The job is running. + * + * Generated from protobuf enum RUNNING = 2; + */ + const RUNNING = 2; + /** + * The job is being canceled. + * + * Generated from protobuf enum CANCELING = 3; + */ + const CANCELING = 3; + /** + * The job is canceled. + * + * Generated from protobuf enum CANCELED = 4; + */ + const CANCELED = 4; + /** + * The job succeeded. + * + * Generated from protobuf enum SUCCEEDED = 5; + */ + const SUCCEEDED = 5; + /** + * The job failed. + * + * Generated from protobuf enum FAILED = 6; + */ + const FAILED = 6; + /** + * The job completed with some errors. + * + * Generated from protobuf enum SUCCEEDED_WITH_ERRORS = 7; + */ + const SUCCEEDED_WITH_ERRORS = 7; + + private static $valueToName = [ + self::STATE_UNSPECIFIED => 'STATE_UNSPECIFIED', + self::QUEUED => 'QUEUED', + self::RUNNING => 'RUNNING', + self::CANCELING => 'CANCELING', + self::CANCELED => 'CANCELED', + self::SUCCEEDED => 'SUCCEEDED', + self::FAILED => 'FAILED', + self::SUCCEEDED_WITH_ERRORS => 'SUCCEEDED_WITH_ERRORS', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Dataplex/src/V1/MetadataJob/Type.php b/Dataplex/src/V1/MetadataJob/Type.php new file mode 100644 index 000000000000..8b9e288df99f --- /dev/null +++ b/Dataplex/src/V1/MetadataJob/Type.php @@ -0,0 +1,55 @@ +google.cloud.dataplex.v1.MetadataJob.Type + */ +class Type +{ + /** + * Unspecified. + * + * Generated from protobuf enum TYPE_UNSPECIFIED = 0; + */ + const TYPE_UNSPECIFIED = 0; + /** + * Import job. + * + * Generated from protobuf enum IMPORT = 1; + */ + const IMPORT = 1; + + private static $valueToName = [ + self::TYPE_UNSPECIFIED => 'TYPE_UNSPECIFIED', + self::IMPORT => 'IMPORT', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + + diff --git a/Dataplex/src/V1/SearchEntriesRequest.php b/Dataplex/src/V1/SearchEntriesRequest.php index fc19ada6019b..e20d3397e1cf 100644 --- a/Dataplex/src/V1/SearchEntriesRequest.php +++ b/Dataplex/src/V1/SearchEntriesRequest.php @@ -17,7 +17,7 @@ class SearchEntriesRequest extends \Google\Protobuf\Internal\Message * Required. The project to which the request should be attributed in the * following form: `projects/{project}/locations/{location}`. * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ protected $name = ''; /** @@ -27,26 +27,31 @@ class SearchEntriesRequest extends \Google\Protobuf\Internal\Message */ protected $query = ''; /** - * Optional. Pagination. + * Optional. Number of results in the search page. If <=0, then defaults + * to 10. Max limit for page_size is 1000. Throws an invalid argument for + * page_size > 1000. * * Generated from protobuf field int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_size = 0; /** + * Optional. Page token received from a previous `SearchEntries` call. Provide + * this to retrieve the subsequent page. + * * Generated from protobuf field string page_token = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $page_token = ''; /** - * Optional. Ordering of the results. Supported options to be added later. + * Optional. Specifies the ordering of results. * * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; */ protected $order_by = ''; /** - * Optional. The scope under which the search should be operating. Should - * either be organizations/ or projects/. If left - * unspecified, it will default to the organization where the project provided - * in `name` is located. + * Optional. The scope under which the search should be operating. It must + * either be `organizations/` or `projects/`. If it is + * unspecified, it defaults to the organization where the project provided in + * `name` is located. * * Generated from protobuf field string scope = 7 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -54,7 +59,8 @@ class SearchEntriesRequest extends \Google\Protobuf\Internal\Message /** * @param string $name Required. The project to which the request should be attributed in the - * following form: `projects/{project}/locations/{location}`. + * following form: `projects/{project}/locations/{location}`. Please see + * {@see CatalogServiceClient::locationName()} for help formatting this field. * @param string $query Required. The query against which entries in scope should be matched. * * @return \Google\Cloud\Dataplex\V1\SearchEntriesRequest @@ -80,15 +86,19 @@ public static function build(string $name, string $query): self * @type string $query * Required. The query against which entries in scope should be matched. * @type int $page_size - * Optional. Pagination. + * Optional. Number of results in the search page. If <=0, then defaults + * to 10. Max limit for page_size is 1000. Throws an invalid argument for + * page_size > 1000. * @type string $page_token + * Optional. Page token received from a previous `SearchEntries` call. Provide + * this to retrieve the subsequent page. * @type string $order_by - * Optional. Ordering of the results. Supported options to be added later. + * Optional. Specifies the ordering of results. * @type string $scope - * Optional. The scope under which the search should be operating. Should - * either be organizations/ or projects/. If left - * unspecified, it will default to the organization where the project provided - * in `name` is located. + * Optional. The scope under which the search should be operating. It must + * either be `organizations/` or `projects/`. If it is + * unspecified, it defaults to the organization where the project provided in + * `name` is located. * } */ public function __construct($data = NULL) { @@ -100,7 +110,7 @@ public function __construct($data = NULL) { * Required. The project to which the request should be attributed in the * following form: `projects/{project}/locations/{location}`. * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string */ public function getName() @@ -112,7 +122,7 @@ public function getName() * Required. The project to which the request should be attributed in the * following form: `projects/{project}/locations/{location}`. * - * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; + * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var * @return $this */ @@ -151,7 +161,9 @@ public function setQuery($var) } /** - * Optional. Pagination. + * Optional. Number of results in the search page. If <=0, then defaults + * to 10. Max limit for page_size is 1000. Throws an invalid argument for + * page_size > 1000. * * Generated from protobuf field int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -162,7 +174,9 @@ public function getPageSize() } /** - * Optional. Pagination. + * Optional. Number of results in the search page. If <=0, then defaults + * to 10. Max limit for page_size is 1000. Throws an invalid argument for + * page_size > 1000. * * Generated from protobuf field int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var @@ -177,6 +191,9 @@ public function setPageSize($var) } /** + * Optional. Page token received from a previous `SearchEntries` call. Provide + * this to retrieve the subsequent page. + * * Generated from protobuf field string page_token = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ @@ -186,6 +203,9 @@ public function getPageToken() } /** + * Optional. Page token received from a previous `SearchEntries` call. Provide + * this to retrieve the subsequent page. + * * Generated from protobuf field string page_token = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this @@ -199,7 +219,7 @@ public function setPageToken($var) } /** - * Optional. Ordering of the results. Supported options to be added later. + * Optional. Specifies the ordering of results. * * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -210,7 +230,7 @@ public function getOrderBy() } /** - * Optional. Ordering of the results. Supported options to be added later. + * Optional. Specifies the ordering of results. * * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var @@ -225,10 +245,10 @@ public function setOrderBy($var) } /** - * Optional. The scope under which the search should be operating. Should - * either be organizations/ or projects/. If left - * unspecified, it will default to the organization where the project provided - * in `name` is located. + * Optional. The scope under which the search should be operating. It must + * either be `organizations/` or `projects/`. If it is + * unspecified, it defaults to the organization where the project provided in + * `name` is located. * * Generated from protobuf field string scope = 7 [(.google.api.field_behavior) = OPTIONAL]; * @return string @@ -239,10 +259,10 @@ public function getScope() } /** - * Optional. The scope under which the search should be operating. Should - * either be organizations/ or projects/. If left - * unspecified, it will default to the organization where the project provided - * in `name` is located. + * Optional. The scope under which the search should be operating. It must + * either be `organizations/` or `projects/`. If it is + * unspecified, it defaults to the organization where the project provided in + * `name` is located. * * Generated from protobuf field string scope = 7 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var diff --git a/Dataplex/src/V1/SearchEntriesResponse.php b/Dataplex/src/V1/SearchEntriesResponse.php index 6c428f353aaa..f2ac81d64feb 100644 --- a/Dataplex/src/V1/SearchEntriesResponse.php +++ b/Dataplex/src/V1/SearchEntriesResponse.php @@ -20,21 +20,22 @@ class SearchEntriesResponse extends \Google\Protobuf\Internal\Message */ private $results; /** - * The estimated total number of matching entries. Not guaranteed to be - * accurate. + * The estimated total number of matching entries. This number isn't + * guaranteed to be accurate. * * Generated from protobuf field int32 total_size = 2; */ protected $total_size = 0; /** - * Pagination token. + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. * * Generated from protobuf field string next_page_token = 3; */ protected $next_page_token = ''; /** - * Unreachable locations. Search results don't include data from those - * locations. + * Locations that the service couldn't reach. Search results don't include + * data from these locations. * * Generated from protobuf field repeated string unreachable = 4; */ @@ -49,13 +50,14 @@ class SearchEntriesResponse extends \Google\Protobuf\Internal\Message * @type array<\Google\Cloud\Dataplex\V1\SearchEntriesResult>|\Google\Protobuf\Internal\RepeatedField $results * The results matching the search query. * @type int $total_size - * The estimated total number of matching entries. Not guaranteed to be - * accurate. + * The estimated total number of matching entries. This number isn't + * guaranteed to be accurate. * @type string $next_page_token - * Pagination token. + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. * @type array|\Google\Protobuf\Internal\RepeatedField $unreachable - * Unreachable locations. Search results don't include data from those - * locations. + * Locations that the service couldn't reach. Search results don't include + * data from these locations. * } */ public function __construct($data = NULL) { @@ -90,8 +92,8 @@ public function setResults($var) } /** - * The estimated total number of matching entries. Not guaranteed to be - * accurate. + * The estimated total number of matching entries. This number isn't + * guaranteed to be accurate. * * Generated from protobuf field int32 total_size = 2; * @return int @@ -102,8 +104,8 @@ public function getTotalSize() } /** - * The estimated total number of matching entries. Not guaranteed to be - * accurate. + * The estimated total number of matching entries. This number isn't + * guaranteed to be accurate. * * Generated from protobuf field int32 total_size = 2; * @param int $var @@ -118,7 +120,8 @@ public function setTotalSize($var) } /** - * Pagination token. + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. * * Generated from protobuf field string next_page_token = 3; * @return string @@ -129,7 +132,8 @@ public function getNextPageToken() } /** - * Pagination token. + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. * * Generated from protobuf field string next_page_token = 3; * @param string $var @@ -144,8 +148,8 @@ public function setNextPageToken($var) } /** - * Unreachable locations. Search results don't include data from those - * locations. + * Locations that the service couldn't reach. Search results don't include + * data from these locations. * * Generated from protobuf field repeated string unreachable = 4; * @return \Google\Protobuf\Internal\RepeatedField @@ -156,8 +160,8 @@ public function getUnreachable() } /** - * Unreachable locations. Search results don't include data from those - * locations. + * Locations that the service couldn't reach. Search results don't include + * data from these locations. * * Generated from protobuf field repeated string unreachable = 4; * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Dataplex/src/V1/Task/SparkTaskConfig.php b/Dataplex/src/V1/Task/SparkTaskConfig.php index 48452cd818c0..b9eeabb656d3 100644 --- a/Dataplex/src/V1/Task/SparkTaskConfig.php +++ b/Dataplex/src/V1/Task/SparkTaskConfig.php @@ -59,10 +59,9 @@ class SparkTaskConfig extends \Google\Protobuf\Internal\Message * Must be a .py file. The execution args are passed in as a sequence of * named process arguments (`--key=value`). * @type string $sql_script_file - * A reference to a query file. This can be the Cloud Storage URI of the - * query file or it can the path to a SqlScript Content. The execution - * args are used to declare a set of script variables - * (`set key="value";`). + * A reference to a query file. This should be the Cloud Storage URI of + * the query file. The execution args are used to declare a set of script + * variables (`set key="value";`). * @type string $sql_script * The query text. * The execution args are used to declare a set of script variables @@ -193,10 +192,9 @@ public function setPythonScriptFile($var) } /** - * A reference to a query file. This can be the Cloud Storage URI of the - * query file or it can the path to a SqlScript Content. The execution - * args are used to declare a set of script variables - * (`set key="value";`). + * A reference to a query file. This should be the Cloud Storage URI of + * the query file. The execution args are used to declare a set of script + * variables (`set key="value";`). * * Generated from protobuf field string sql_script_file = 104; * @return string @@ -212,10 +210,9 @@ public function hasSqlScriptFile() } /** - * A reference to a query file. This can be the Cloud Storage URI of the - * query file or it can the path to a SqlScript Content. The execution - * args are used to declare a set of script variables - * (`set key="value";`). + * A reference to a query file. This should be the Cloud Storage URI of + * the query file. The execution args are used to declare a set of script + * variables (`set key="value";`). * * Generated from protobuf field string sql_script_file = 104; * @param string $var diff --git a/Dataplex/src/V1/UpdateEntryGroupRequest.php b/Dataplex/src/V1/UpdateEntryGroupRequest.php index 16978408b1f5..50043c9332d7 100644 --- a/Dataplex/src/V1/UpdateEntryGroupRequest.php +++ b/Dataplex/src/V1/UpdateEntryGroupRequest.php @@ -9,14 +9,14 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Update EntryGroup Request + * Update EntryGroup Request. * * Generated from protobuf message google.cloud.dataplex.v1.UpdateEntryGroupRequest */ class UpdateEntryGroupRequest extends \Google\Protobuf\Internal\Message { /** - * Required. EntryGroup Resource + * Required. EntryGroup Resource. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryGroup entry_group = 1 [(.google.api.field_behavior) = REQUIRED]; */ @@ -28,15 +28,15 @@ class UpdateEntryGroupRequest extends \Google\Protobuf\Internal\Message */ protected $update_mask = null; /** - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request, without performing any + * mutations. The default is false. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; /** - * @param \Google\Cloud\Dataplex\V1\EntryGroup $entryGroup Required. EntryGroup Resource + * @param \Google\Cloud\Dataplex\V1\EntryGroup $entryGroup Required. EntryGroup Resource. * @param \Google\Protobuf\FieldMask $updateMask Required. Mask of fields to update. * * @return \Google\Cloud\Dataplex\V1\UpdateEntryGroupRequest @@ -57,12 +57,12 @@ public static function build(\Google\Cloud\Dataplex\V1\EntryGroup $entryGroup, \ * Optional. Data for populating the Message object. * * @type \Google\Cloud\Dataplex\V1\EntryGroup $entry_group - * Required. EntryGroup Resource + * Required. EntryGroup Resource. * @type \Google\Protobuf\FieldMask $update_mask * Required. Mask of fields to update. * @type bool $validate_only - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request, without performing any + * mutations. The default is false. * } */ public function __construct($data = NULL) { @@ -71,7 +71,7 @@ public function __construct($data = NULL) { } /** - * Required. EntryGroup Resource + * Required. EntryGroup Resource. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryGroup entry_group = 1 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\Dataplex\V1\EntryGroup|null @@ -92,7 +92,7 @@ public function clearEntryGroup() } /** - * Required. EntryGroup Resource + * Required. EntryGroup Resource. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryGroup entry_group = 1 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\Dataplex\V1\EntryGroup $var @@ -143,8 +143,8 @@ public function setUpdateMask($var) } /** - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request, without performing any + * mutations. The default is false. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -155,8 +155,8 @@ public function getValidateOnly() } /** - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request, without performing any + * mutations. The default is false. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/Dataplex/src/V1/UpdateEntryRequest.php b/Dataplex/src/V1/UpdateEntryRequest.php index e1e12c835e8a..7b1b52534d6f 100644 --- a/Dataplex/src/V1/UpdateEntryRequest.php +++ b/Dataplex/src/V1/UpdateEntryRequest.php @@ -9,6 +9,8 @@ use Google\Protobuf\Internal\GPBUtil; /** + * Update Entry request. + * * Generated from protobuf message google.cloud.dataplex.v1.UpdateEntryRequest */ class UpdateEntryRequest extends \Google\Protobuf\Internal\Message @@ -22,38 +24,43 @@ class UpdateEntryRequest extends \Google\Protobuf\Internal\Message /** * Optional. Mask of fields to update. To update Aspects, the update_mask must * contain the value "aspects". - * If the update_mask is empty, all modifiable fields present in the request - * will be updated. + * If the update_mask is empty, the service will update all modifiable fields + * present in the request. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL]; */ protected $update_mask = null; /** - * Optional. If set to true and the entry does not exist, it will be created. + * Optional. If set to true and the entry doesn't exist, the service will + * create it. * * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $allow_missing = false; /** - * Optional. If set to true and the aspect_keys specify aspect ranges, any - * existing aspects from that range not provided in the request will be - * deleted. + * Optional. If set to true and the aspect_keys specify aspect ranges, the + * service deletes any existing aspects from that range that weren't provided + * in the request. * * Generated from protobuf field bool delete_missing_aspects = 4 [(.google.api.field_behavior) = OPTIONAL]; */ protected $delete_missing_aspects = false; /** - * Optional. The map keys of the Aspects which should be modified. Supports - * the following syntaxes: - * * - matches aspect on given type and empty path - * * @path - matches aspect on given type and specified - * path - * * * - matches aspects on given type for all paths - * * *@path - matches aspects of all types on the given path - * Existing aspects matching the syntax will not be removed unless + * Optional. The map keys of the Aspects which the service should modify. It + * supports the following syntaxes: + * * `` - matches an aspect of the given type and empty + * path. + * * `@path` - matches an aspect of the given type and + * specified path. For example, to attach an aspect to a field that is + * specified by the `schema` aspect, the path should have the format + * `Schema.`. + * * `*` - matches aspects of the given type for all + * paths. + * * `*@path` - matches aspects of all types on the given path. + * The service will not remove existing aspects matching the syntax unless * `delete_missing_aspects` is set to true. - * If this field is left empty, it will be treated as specifying exactly those - * Aspects present in the request. + * If this field is left empty, the service treats it as specifying + * exactly those Aspects present in the request. * * Generated from protobuf field repeated string aspect_keys = 5 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -64,8 +71,8 @@ class UpdateEntryRequest extends \Google\Protobuf\Internal\Message * @param \Google\Protobuf\FieldMask $updateMask Optional. Mask of fields to update. To update Aspects, the update_mask must * contain the value "aspects". * - * If the update_mask is empty, all modifiable fields present in the request - * will be updated. + * If the update_mask is empty, the service will update all modifiable fields + * present in the request. * * @return \Google\Cloud\Dataplex\V1\UpdateEntryRequest * @@ -89,26 +96,31 @@ public static function build(\Google\Cloud\Dataplex\V1\Entry $entry, \Google\Pro * @type \Google\Protobuf\FieldMask $update_mask * Optional. Mask of fields to update. To update Aspects, the update_mask must * contain the value "aspects". - * If the update_mask is empty, all modifiable fields present in the request - * will be updated. + * If the update_mask is empty, the service will update all modifiable fields + * present in the request. * @type bool $allow_missing - * Optional. If set to true and the entry does not exist, it will be created. + * Optional. If set to true and the entry doesn't exist, the service will + * create it. * @type bool $delete_missing_aspects - * Optional. If set to true and the aspect_keys specify aspect ranges, any - * existing aspects from that range not provided in the request will be - * deleted. + * Optional. If set to true and the aspect_keys specify aspect ranges, the + * service deletes any existing aspects from that range that weren't provided + * in the request. * @type array|\Google\Protobuf\Internal\RepeatedField $aspect_keys - * Optional. The map keys of the Aspects which should be modified. Supports - * the following syntaxes: - * * - matches aspect on given type and empty path - * * @path - matches aspect on given type and specified - * path - * * * - matches aspects on given type for all paths - * * *@path - matches aspects of all types on the given path - * Existing aspects matching the syntax will not be removed unless + * Optional. The map keys of the Aspects which the service should modify. It + * supports the following syntaxes: + * * `` - matches an aspect of the given type and empty + * path. + * * `@path` - matches an aspect of the given type and + * specified path. For example, to attach an aspect to a field that is + * specified by the `schema` aspect, the path should have the format + * `Schema.`. + * * `*` - matches aspects of the given type for all + * paths. + * * `*@path` - matches aspects of all types on the given path. + * The service will not remove existing aspects matching the syntax unless * `delete_missing_aspects` is set to true. - * If this field is left empty, it will be treated as specifying exactly those - * Aspects present in the request. + * If this field is left empty, the service treats it as specifying + * exactly those Aspects present in the request. * } */ public function __construct($data = NULL) { @@ -155,8 +167,8 @@ public function setEntry($var) /** * Optional. Mask of fields to update. To update Aspects, the update_mask must * contain the value "aspects". - * If the update_mask is empty, all modifiable fields present in the request - * will be updated. + * If the update_mask is empty, the service will update all modifiable fields + * present in the request. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\FieldMask|null @@ -179,8 +191,8 @@ public function clearUpdateMask() /** * Optional. Mask of fields to update. To update Aspects, the update_mask must * contain the value "aspects". - * If the update_mask is empty, all modifiable fields present in the request - * will be updated. + * If the update_mask is empty, the service will update all modifiable fields + * present in the request. * * Generated from protobuf field .google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param \Google\Protobuf\FieldMask $var @@ -195,7 +207,8 @@ public function setUpdateMask($var) } /** - * Optional. If set to true and the entry does not exist, it will be created. + * Optional. If set to true and the entry doesn't exist, the service will + * create it. * * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -206,7 +219,8 @@ public function getAllowMissing() } /** - * Optional. If set to true and the entry does not exist, it will be created. + * Optional. If set to true and the entry doesn't exist, the service will + * create it. * * Generated from protobuf field bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var @@ -221,9 +235,9 @@ public function setAllowMissing($var) } /** - * Optional. If set to true and the aspect_keys specify aspect ranges, any - * existing aspects from that range not provided in the request will be - * deleted. + * Optional. If set to true and the aspect_keys specify aspect ranges, the + * service deletes any existing aspects from that range that weren't provided + * in the request. * * Generated from protobuf field bool delete_missing_aspects = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -234,9 +248,9 @@ public function getDeleteMissingAspects() } /** - * Optional. If set to true and the aspect_keys specify aspect ranges, any - * existing aspects from that range not provided in the request will be - * deleted. + * Optional. If set to true and the aspect_keys specify aspect ranges, the + * service deletes any existing aspects from that range that weren't provided + * in the request. * * Generated from protobuf field bool delete_missing_aspects = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var @@ -251,17 +265,21 @@ public function setDeleteMissingAspects($var) } /** - * Optional. The map keys of the Aspects which should be modified. Supports - * the following syntaxes: - * * - matches aspect on given type and empty path - * * @path - matches aspect on given type and specified - * path - * * * - matches aspects on given type for all paths - * * *@path - matches aspects of all types on the given path - * Existing aspects matching the syntax will not be removed unless + * Optional. The map keys of the Aspects which the service should modify. It + * supports the following syntaxes: + * * `` - matches an aspect of the given type and empty + * path. + * * `@path` - matches an aspect of the given type and + * specified path. For example, to attach an aspect to a field that is + * specified by the `schema` aspect, the path should have the format + * `Schema.`. + * * `*` - matches aspects of the given type for all + * paths. + * * `*@path` - matches aspects of all types on the given path. + * The service will not remove existing aspects matching the syntax unless * `delete_missing_aspects` is set to true. - * If this field is left empty, it will be treated as specifying exactly those - * Aspects present in the request. + * If this field is left empty, the service treats it as specifying + * exactly those Aspects present in the request. * * Generated from protobuf field repeated string aspect_keys = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return \Google\Protobuf\Internal\RepeatedField @@ -272,17 +290,21 @@ public function getAspectKeys() } /** - * Optional. The map keys of the Aspects which should be modified. Supports - * the following syntaxes: - * * - matches aspect on given type and empty path - * * @path - matches aspect on given type and specified - * path - * * * - matches aspects on given type for all paths - * * *@path - matches aspects of all types on the given path - * Existing aspects matching the syntax will not be removed unless + * Optional. The map keys of the Aspects which the service should modify. It + * supports the following syntaxes: + * * `` - matches an aspect of the given type and empty + * path. + * * `@path` - matches an aspect of the given type and + * specified path. For example, to attach an aspect to a field that is + * specified by the `schema` aspect, the path should have the format + * `Schema.`. + * * `*` - matches aspects of the given type for all + * paths. + * * `*@path` - matches aspects of all types on the given path. + * The service will not remove existing aspects matching the syntax unless * `delete_missing_aspects` is set to true. - * If this field is left empty, it will be treated as specifying exactly those - * Aspects present in the request. + * If this field is left empty, the service treats it as specifying + * exactly those Aspects present in the request. * * Generated from protobuf field repeated string aspect_keys = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param array|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Dataplex/src/V1/UpdateEntryTypeRequest.php b/Dataplex/src/V1/UpdateEntryTypeRequest.php index 5bf45c876e45..d939ecc060e0 100644 --- a/Dataplex/src/V1/UpdateEntryTypeRequest.php +++ b/Dataplex/src/V1/UpdateEntryTypeRequest.php @@ -9,14 +9,14 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Update EntryType Request + * Update EntryType Request. * * Generated from protobuf message google.cloud.dataplex.v1.UpdateEntryTypeRequest */ class UpdateEntryTypeRequest extends \Google\Protobuf\Internal\Message { /** - * Required. EntryType Resource + * Required. EntryType Resource. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryType entry_type = 1 [(.google.api.field_behavior) = REQUIRED]; */ @@ -28,15 +28,15 @@ class UpdateEntryTypeRequest extends \Google\Protobuf\Internal\Message */ protected $update_mask = null; /** - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; */ protected $validate_only = false; /** - * @param \Google\Cloud\Dataplex\V1\EntryType $entryType Required. EntryType Resource + * @param \Google\Cloud\Dataplex\V1\EntryType $entryType Required. EntryType Resource. * @param \Google\Protobuf\FieldMask $updateMask Required. Mask of fields to update. * * @return \Google\Cloud\Dataplex\V1\UpdateEntryTypeRequest @@ -57,12 +57,12 @@ public static function build(\Google\Cloud\Dataplex\V1\EntryType $entryType, \Go * Optional. Data for populating the Message object. * * @type \Google\Cloud\Dataplex\V1\EntryType $entry_type - * Required. EntryType Resource + * Required. EntryType Resource. * @type \Google\Protobuf\FieldMask $update_mask * Required. Mask of fields to update. * @type bool $validate_only - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * } */ public function __construct($data = NULL) { @@ -71,7 +71,7 @@ public function __construct($data = NULL) { } /** - * Required. EntryType Resource + * Required. EntryType Resource. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryType entry_type = 1 [(.google.api.field_behavior) = REQUIRED]; * @return \Google\Cloud\Dataplex\V1\EntryType|null @@ -92,7 +92,7 @@ public function clearEntryType() } /** - * Required. EntryType Resource + * Required. EntryType Resource. * * Generated from protobuf field .google.cloud.dataplex.v1.EntryType entry_type = 1 [(.google.api.field_behavior) = REQUIRED]; * @param \Google\Cloud\Dataplex\V1\EntryType $var @@ -143,8 +143,8 @@ public function setUpdateMask($var) } /** - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return bool @@ -155,8 +155,8 @@ public function getValidateOnly() } /** - * Optional. Only validate the request, but do not perform mutations. - * The default is false. + * Optional. The service validates the request without performing any + * mutations. The default is false. * * Generated from protobuf field bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param bool $var diff --git a/Dataplex/src/V1/gapic_metadata.json b/Dataplex/src/V1/gapic_metadata.json index 338cbda745f8..2e5b764e8b7c 100644 --- a/Dataplex/src/V1/gapic_metadata.json +++ b/Dataplex/src/V1/gapic_metadata.json @@ -209,6 +209,11 @@ "grpc": { "libraryClient": "CatalogServiceGapicClient", "rpcs": { + "CancelMetadataJob": { + "methods": [ + "cancelMetadataJob" + ] + }, "CreateAspectType": { "methods": [ "createAspectType" @@ -229,6 +234,11 @@ "createEntryType" ] }, + "CreateMetadataJob": { + "methods": [ + "createMetadataJob" + ] + }, "DeleteAspectType": { "methods": [ "deleteAspectType" @@ -269,6 +279,11 @@ "getEntryType" ] }, + "GetMetadataJob": { + "methods": [ + "getMetadataJob" + ] + }, "ListAspectTypes": { "methods": [ "listAspectTypes" @@ -289,6 +304,11 @@ "listEntryTypes" ] }, + "ListMetadataJobs": { + "methods": [ + "listMetadataJobs" + ] + }, "LookupEntry": { "methods": [ "lookupEntry" diff --git a/Dataplex/src/V1/resources/catalog_service_client_config.json b/Dataplex/src/V1/resources/catalog_service_client_config.json index f5d336dc51b9..f14c8b621df8 100644 --- a/Dataplex/src/V1/resources/catalog_service_client_config.json +++ b/Dataplex/src/V1/resources/catalog_service_client_config.json @@ -75,6 +75,11 @@ } }, "methods": { + "CancelMetadataJob": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "CreateAspectType": { "timeout_millis": 60000, "retry_codes_name": "no_retry_5_codes", @@ -95,6 +100,11 @@ "retry_codes_name": "no_retry_5_codes", "retry_params_name": "no_retry_5_params" }, + "CreateMetadataJob": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "DeleteAspectType": { "timeout_millis": 60000, "retry_codes_name": "no_retry_5_codes", @@ -135,6 +145,11 @@ "retry_codes_name": "retry_policy_9_codes", "retry_params_name": "retry_policy_9_params" }, + "GetMetadataJob": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "ListAspectTypes": { "timeout_millis": 60000, "retry_codes_name": "retry_policy_9_codes", @@ -155,6 +170,11 @@ "retry_codes_name": "retry_policy_9_codes", "retry_params_name": "retry_policy_9_params" }, + "ListMetadataJobs": { + "timeout_millis": 60000, + "retry_codes_name": "no_retry_codes", + "retry_params_name": "no_retry_params" + }, "LookupEntry": { "timeout_millis": 20000, "retry_codes_name": "retry_policy_7_codes", diff --git a/Dataplex/src/V1/resources/catalog_service_descriptor_config.php b/Dataplex/src/V1/resources/catalog_service_descriptor_config.php index 4fb6f9c29697..30f1847e2120 100644 --- a/Dataplex/src/V1/resources/catalog_service_descriptor_config.php +++ b/Dataplex/src/V1/resources/catalog_service_descriptor_config.php @@ -80,6 +80,25 @@ ], ], ], + 'CreateMetadataJob' => [ + 'longRunning' => [ + 'operationReturnType' => '\Google\Cloud\Dataplex\V1\MetadataJob', + 'metadataReturnType' => '\Google\Cloud\Dataplex\V1\OperationMetadata', + 'initialPollDelayMillis' => '500', + 'pollDelayMultiplier' => '1.5', + 'maxPollDelayMillis' => '5000', + 'totalPollTimeoutMillis' => '300000', + ], + 'callType' => \Google\ApiCore\Call::LONGRUNNING_CALL, + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'DeleteAspectType' => [ 'longRunning' => [ 'operationReturnType' => '\Google\Protobuf\GPBEmpty', @@ -197,6 +216,18 @@ ], ], ], + 'CancelMetadataJob' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Protobuf\GPBEmpty', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'CreateEntry' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\Dataplex\V1\Entry', @@ -269,6 +300,18 @@ ], ], ], + 'GetMetadataJob' => [ + 'callType' => \Google\ApiCore\Call::UNARY_CALL, + 'responseType' => 'Google\Cloud\Dataplex\V1\MetadataJob', + 'headerParams' => [ + [ + 'keyName' => 'name', + 'fieldAccessors' => [ + 'getName', + ], + ], + ], + ], 'ListAspectTypes' => [ 'pageStreaming' => [ 'requestPageTokenGetMethod' => 'getPageToken', @@ -349,6 +392,26 @@ ], ], ], + 'ListMetadataJobs' => [ + 'pageStreaming' => [ + 'requestPageTokenGetMethod' => 'getPageToken', + 'requestPageTokenSetMethod' => 'setPageToken', + 'requestPageSizeGetMethod' => 'getPageSize', + 'requestPageSizeSetMethod' => 'setPageSize', + 'responsePageTokenGetMethod' => 'getNextPageToken', + 'resourcesGetMethod' => 'getMetadataJobs', + ], + 'callType' => \Google\ApiCore\Call::PAGINATED_CALL, + 'responseType' => 'Google\Cloud\Dataplex\V1\ListMetadataJobsResponse', + 'headerParams' => [ + [ + 'keyName' => 'parent', + 'fieldAccessors' => [ + 'getParent', + ], + ], + ], + ], 'LookupEntry' => [ 'callType' => \Google\ApiCore\Call::UNARY_CALL, 'responseType' => 'Google\Cloud\Dataplex\V1\Entry', @@ -473,6 +536,7 @@ 'entryGroup' => 'projects/{project}/locations/{location}/entryGroups/{entry_group}', 'entryType' => 'projects/{project}/locations/{location}/entryTypes/{entry_type}', 'location' => 'projects/{project}/locations/{location}', + 'metadataJob' => 'projects/{project}/locations/{location}/metadataJobs/{metadataJob}', ], ], ], diff --git a/Dataplex/src/V1/resources/catalog_service_rest_client_config.php b/Dataplex/src/V1/resources/catalog_service_rest_client_config.php index 162e126e7aca..ebe74bfde81a 100644 --- a/Dataplex/src/V1/resources/catalog_service_rest_client_config.php +++ b/Dataplex/src/V1/resources/catalog_service_rest_client_config.php @@ -23,6 +23,18 @@ return [ 'interfaces' => [ 'google.cloud.dataplex.v1.CatalogService' => [ + 'CancelMetadataJob' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/metadataJobs/*}:cancel', + 'body' => '*', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'CreateAspectType' => [ 'method' => 'post', 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/aspectTypes', @@ -83,6 +95,18 @@ 'entry_type_id', ], ], + 'CreateMetadataJob' => [ + 'method' => 'post', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/metadataJobs', + 'body' => 'metadata_job', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], 'DeleteAspectType' => [ 'method' => 'delete', 'uriTemplate' => '/v1/{name=projects/*/locations/*/aspectTypes/*}', @@ -171,6 +195,17 @@ ], ], ], + 'GetMetadataJob' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=projects/*/locations/*/metadataJobs/*}', + 'placeholders' => [ + 'name' => [ + 'getters' => [ + 'getName', + ], + ], + ], + ], 'ListAspectTypes' => [ 'method' => 'get', 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/aspectTypes', @@ -215,6 +250,17 @@ ], ], ], + 'ListMetadataJobs' => [ + 'method' => 'get', + 'uriTemplate' => '/v1/{parent=projects/*/locations/*}/metadataJobs', + 'placeholders' => [ + 'parent' => [ + 'getters' => [ + 'getParent', + ], + ], + ], + ], 'LookupEntry' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*}:lookupEntry', @@ -364,6 +410,10 @@ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:getIamPolicy', ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:getIamPolicy', + ], [ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:getIamPolicy', @@ -376,6 +426,22 @@ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:getIamPolicy', ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:getIamPolicy', + ], ], 'placeholders' => [ 'resource' => [ @@ -435,6 +501,11 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:setIamPolicy', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:setIamPolicy', + 'body' => '*', + ], [ 'method' => 'post', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:setIamPolicy', @@ -450,6 +521,26 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:setIamPolicy', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:setIamPolicy', + 'body' => '*', + ], ], 'placeholders' => [ 'resource' => [ @@ -509,6 +600,11 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:testIamPermissions', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:testIamPermissions', + 'body' => '*', + ], [ 'method' => 'post', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:testIamPermissions', @@ -524,6 +620,26 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:testIamPermissions', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:testIamPermissions', + 'body' => '*', + ], ], 'placeholders' => [ 'resource' => [ @@ -539,6 +655,13 @@ 'method' => 'post', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}:cancel', 'body' => '*', + 'additionalBindings' => [ + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}:cancel', + 'body' => '*', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -550,6 +673,12 @@ 'DeleteOperation' => [ 'method' => 'delete', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}', + 'additionalBindings' => [ + [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -561,6 +690,12 @@ 'GetOperation' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -572,6 +707,12 @@ 'ListOperations' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*}/operations', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ diff --git a/Dataplex/src/V1/resources/content_service_rest_client_config.php b/Dataplex/src/V1/resources/content_service_rest_client_config.php index 0dcaf936b334..592f833989d0 100644 --- a/Dataplex/src/V1/resources/content_service_rest_client_config.php +++ b/Dataplex/src/V1/resources/content_service_rest_client_config.php @@ -240,6 +240,10 @@ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:getIamPolicy', ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:getIamPolicy', + ], [ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:getIamPolicy', @@ -252,6 +256,22 @@ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:getIamPolicy', ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:getIamPolicy', + ], ], 'placeholders' => [ 'resource' => [ @@ -311,6 +331,11 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:setIamPolicy', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:setIamPolicy', + 'body' => '*', + ], [ 'method' => 'post', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:setIamPolicy', @@ -326,6 +351,26 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:setIamPolicy', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:setIamPolicy', + 'body' => '*', + ], ], 'placeholders' => [ 'resource' => [ @@ -385,6 +430,11 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:testIamPermissions', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:testIamPermissions', + 'body' => '*', + ], [ 'method' => 'post', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:testIamPermissions', @@ -400,6 +450,26 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:testIamPermissions', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:testIamPermissions', + 'body' => '*', + ], ], 'placeholders' => [ 'resource' => [ @@ -415,6 +485,13 @@ 'method' => 'post', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}:cancel', 'body' => '*', + 'additionalBindings' => [ + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}:cancel', + 'body' => '*', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -426,6 +503,12 @@ 'DeleteOperation' => [ 'method' => 'delete', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}', + 'additionalBindings' => [ + [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -437,6 +520,12 @@ 'GetOperation' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -448,6 +537,12 @@ 'ListOperations' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*}/operations', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ diff --git a/Dataplex/src/V1/resources/data_scan_service_descriptor_config.php b/Dataplex/src/V1/resources/data_scan_service_descriptor_config.php index 124541dc6289..247c9ca0714d 100644 --- a/Dataplex/src/V1/resources/data_scan_service_descriptor_config.php +++ b/Dataplex/src/V1/resources/data_scan_service_descriptor_config.php @@ -243,8 +243,10 @@ 'interfaceOverride' => 'google.cloud.location.Locations', ], 'templateMap' => [ + 'connection' => 'projects/{project}/locations/{location}/connections/{connection}', 'dataScan' => 'projects/{project}/locations/{location}/dataScans/{dataScan}', 'dataScanJob' => 'projects/{project}/locations/{location}/dataScans/{dataScan}/jobs/{job}', + 'dataset' => 'projects/{project}/datasets/{dataset}', 'entity' => 'projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}', 'location' => 'projects/{project}/locations/{location}', ], diff --git a/Dataplex/src/V1/resources/data_scan_service_rest_client_config.php b/Dataplex/src/V1/resources/data_scan_service_rest_client_config.php index 88c14e05728b..416aa04726f0 100644 --- a/Dataplex/src/V1/resources/data_scan_service_rest_client_config.php +++ b/Dataplex/src/V1/resources/data_scan_service_rest_client_config.php @@ -206,6 +206,10 @@ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:getIamPolicy', ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:getIamPolicy', + ], [ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:getIamPolicy', @@ -218,6 +222,22 @@ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:getIamPolicy', ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:getIamPolicy', + ], ], 'placeholders' => [ 'resource' => [ @@ -277,6 +297,11 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:setIamPolicy', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:setIamPolicy', + 'body' => '*', + ], [ 'method' => 'post', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:setIamPolicy', @@ -292,6 +317,26 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:setIamPolicy', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:setIamPolicy', + 'body' => '*', + ], ], 'placeholders' => [ 'resource' => [ @@ -351,6 +396,11 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:testIamPermissions', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:testIamPermissions', + 'body' => '*', + ], [ 'method' => 'post', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:testIamPermissions', @@ -366,6 +416,26 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:testIamPermissions', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:testIamPermissions', + 'body' => '*', + ], ], 'placeholders' => [ 'resource' => [ @@ -381,6 +451,13 @@ 'method' => 'post', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}:cancel', 'body' => '*', + 'additionalBindings' => [ + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}:cancel', + 'body' => '*', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -392,6 +469,12 @@ 'DeleteOperation' => [ 'method' => 'delete', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}', + 'additionalBindings' => [ + [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -403,6 +486,12 @@ 'GetOperation' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -414,6 +503,12 @@ 'ListOperations' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*}/operations', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ diff --git a/Dataplex/src/V1/resources/data_taxonomy_service_rest_client_config.php b/Dataplex/src/V1/resources/data_taxonomy_service_rest_client_config.php index a7177928a495..772f000dc86b 100644 --- a/Dataplex/src/V1/resources/data_taxonomy_service_rest_client_config.php +++ b/Dataplex/src/V1/resources/data_taxonomy_service_rest_client_config.php @@ -284,6 +284,10 @@ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:getIamPolicy', ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:getIamPolicy', + ], [ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:getIamPolicy', @@ -296,6 +300,22 @@ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:getIamPolicy', ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:getIamPolicy', + ], ], 'placeholders' => [ 'resource' => [ @@ -355,6 +375,11 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:setIamPolicy', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:setIamPolicy', + 'body' => '*', + ], [ 'method' => 'post', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:setIamPolicy', @@ -370,6 +395,26 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:setIamPolicy', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:setIamPolicy', + 'body' => '*', + ], ], 'placeholders' => [ 'resource' => [ @@ -429,6 +474,11 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:testIamPermissions', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:testIamPermissions', + 'body' => '*', + ], [ 'method' => 'post', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:testIamPermissions', @@ -444,6 +494,26 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:testIamPermissions', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:testIamPermissions', + 'body' => '*', + ], ], 'placeholders' => [ 'resource' => [ @@ -459,6 +529,13 @@ 'method' => 'post', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}:cancel', 'body' => '*', + 'additionalBindings' => [ + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}:cancel', + 'body' => '*', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -470,6 +547,12 @@ 'DeleteOperation' => [ 'method' => 'delete', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}', + 'additionalBindings' => [ + [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -481,6 +564,12 @@ 'GetOperation' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -492,6 +581,12 @@ 'ListOperations' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*}/operations', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ diff --git a/Dataplex/src/V1/resources/dataplex_service_rest_client_config.php b/Dataplex/src/V1/resources/dataplex_service_rest_client_config.php index e35baf81da8e..6698d8bc8023 100644 --- a/Dataplex/src/V1/resources/dataplex_service_rest_client_config.php +++ b/Dataplex/src/V1/resources/dataplex_service_rest_client_config.php @@ -499,6 +499,10 @@ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:getIamPolicy', ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:getIamPolicy', + ], [ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:getIamPolicy', @@ -511,6 +515,22 @@ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:getIamPolicy', ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:getIamPolicy', + ], ], 'placeholders' => [ 'resource' => [ @@ -570,6 +590,11 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:setIamPolicy', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:setIamPolicy', + 'body' => '*', + ], [ 'method' => 'post', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:setIamPolicy', @@ -585,6 +610,26 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:setIamPolicy', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:setIamPolicy', + 'body' => '*', + ], ], 'placeholders' => [ 'resource' => [ @@ -644,6 +689,11 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:testIamPermissions', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:testIamPermissions', + 'body' => '*', + ], [ 'method' => 'post', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:testIamPermissions', @@ -659,6 +709,26 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:testIamPermissions', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:testIamPermissions', + 'body' => '*', + ], ], 'placeholders' => [ 'resource' => [ @@ -674,6 +744,13 @@ 'method' => 'post', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}:cancel', 'body' => '*', + 'additionalBindings' => [ + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}:cancel', + 'body' => '*', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -685,6 +762,12 @@ 'DeleteOperation' => [ 'method' => 'delete', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}', + 'additionalBindings' => [ + [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -696,6 +779,12 @@ 'GetOperation' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -707,6 +796,12 @@ 'ListOperations' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*}/operations', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ diff --git a/Dataplex/src/V1/resources/metadata_service_rest_client_config.php b/Dataplex/src/V1/resources/metadata_service_rest_client_config.php index 30ded483e607..07a678847f93 100644 --- a/Dataplex/src/V1/resources/metadata_service_rest_client_config.php +++ b/Dataplex/src/V1/resources/metadata_service_rest_client_config.php @@ -198,6 +198,10 @@ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:getIamPolicy', ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:getIamPolicy', + ], [ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:getIamPolicy', @@ -210,6 +214,22 @@ 'method' => 'get', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:getIamPolicy', ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:getIamPolicy', + ], + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:getIamPolicy', + ], ], 'placeholders' => [ 'resource' => [ @@ -269,6 +289,11 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:setIamPolicy', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:setIamPolicy', + 'body' => '*', + ], [ 'method' => 'post', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:setIamPolicy', @@ -284,6 +309,26 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:setIamPolicy', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:setIamPolicy', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:setIamPolicy', + 'body' => '*', + ], ], 'placeholders' => [ 'resource' => [ @@ -343,6 +388,11 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryTypes/*}:testIamPermissions', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/entryLinkTypes/*}:testIamPermissions', + 'body' => '*', + ], [ 'method' => 'post', 'uriTemplate' => '/v1/{resource=projects/*/locations/*/aspectTypes/*}:testIamPermissions', @@ -358,6 +408,26 @@ 'uriTemplate' => '/v1/{resource=projects/*/locations/*/governanceRules/*}:testIamPermissions', 'body' => '*', ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/categories/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=projects/*/locations/*/glossaries/*/terms/*}:testIamPermissions', + 'body' => '*', + ], + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{resource=organizations/*/locations/*/encryptionConfigs/*}:testIamPermissions', + 'body' => '*', + ], ], 'placeholders' => [ 'resource' => [ @@ -373,6 +443,13 @@ 'method' => 'post', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}:cancel', 'body' => '*', + 'additionalBindings' => [ + [ + 'method' => 'post', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}:cancel', + 'body' => '*', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -384,6 +461,12 @@ 'DeleteOperation' => [ 'method' => 'delete', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}', + 'additionalBindings' => [ + [ + 'method' => 'delete', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -395,6 +478,12 @@ 'GetOperation' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*/operations/*}', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ @@ -406,6 +495,12 @@ 'ListOperations' => [ 'method' => 'get', 'uriTemplate' => '/v1/{name=projects/*/locations/*}/operations', + 'additionalBindings' => [ + [ + 'method' => 'get', + 'uriTemplate' => '/v1/{name=organizations/*/locations/*/operations/*}', + ], + ], 'placeholders' => [ 'name' => [ 'getters' => [ diff --git a/Dataplex/tests/Unit/V1/Client/CatalogServiceClientTest.php b/Dataplex/tests/Unit/V1/Client/CatalogServiceClientTest.php index 192de6baf6d0..3c3bdc645c61 100644 --- a/Dataplex/tests/Unit/V1/Client/CatalogServiceClientTest.php +++ b/Dataplex/tests/Unit/V1/Client/CatalogServiceClientTest.php @@ -28,11 +28,13 @@ use Google\ApiCore\Testing\MockTransport; use Google\Cloud\Dataplex\V1\AspectType; use Google\Cloud\Dataplex\V1\AspectType\MetadataTemplate; +use Google\Cloud\Dataplex\V1\CancelMetadataJobRequest; use Google\Cloud\Dataplex\V1\Client\CatalogServiceClient; use Google\Cloud\Dataplex\V1\CreateAspectTypeRequest; use Google\Cloud\Dataplex\V1\CreateEntryGroupRequest; use Google\Cloud\Dataplex\V1\CreateEntryRequest; use Google\Cloud\Dataplex\V1\CreateEntryTypeRequest; +use Google\Cloud\Dataplex\V1\CreateMetadataJobRequest; use Google\Cloud\Dataplex\V1\DeleteAspectTypeRequest; use Google\Cloud\Dataplex\V1\DeleteEntryGroupRequest; use Google\Cloud\Dataplex\V1\DeleteEntryRequest; @@ -44,6 +46,7 @@ use Google\Cloud\Dataplex\V1\GetEntryGroupRequest; use Google\Cloud\Dataplex\V1\GetEntryRequest; use Google\Cloud\Dataplex\V1\GetEntryTypeRequest; +use Google\Cloud\Dataplex\V1\GetMetadataJobRequest; use Google\Cloud\Dataplex\V1\ListAspectTypesRequest; use Google\Cloud\Dataplex\V1\ListAspectTypesResponse; use Google\Cloud\Dataplex\V1\ListEntriesRequest; @@ -52,7 +55,11 @@ use Google\Cloud\Dataplex\V1\ListEntryGroupsResponse; use Google\Cloud\Dataplex\V1\ListEntryTypesRequest; use Google\Cloud\Dataplex\V1\ListEntryTypesResponse; +use Google\Cloud\Dataplex\V1\ListMetadataJobsRequest; +use Google\Cloud\Dataplex\V1\ListMetadataJobsResponse; use Google\Cloud\Dataplex\V1\LookupEntryRequest; +use Google\Cloud\Dataplex\V1\MetadataJob; +use Google\Cloud\Dataplex\V1\MetadataJob\Type; use Google\Cloud\Dataplex\V1\SearchEntriesRequest; use Google\Cloud\Dataplex\V1\SearchEntriesResponse; use Google\Cloud\Dataplex\V1\SearchEntriesResult; @@ -108,6 +115,68 @@ private function createClient(array $options = []) return new CatalogServiceClient($options); } + /** @test */ + public function cancelMetadataJobTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $expectedResponse = new GPBEmpty(); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->metadataJobName('[PROJECT]', '[LOCATION]', '[METADATAJOB]'); + $request = (new CancelMetadataJobRequest())->setName($formattedName); + $gapicClient->cancelMetadataJob($request); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.dataplex.v1.CatalogService/CancelMetadataJob', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function cancelMetadataJobExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->metadataJobName('[PROJECT]', '[LOCATION]', '[METADATAJOB]'); + $request = (new CancelMetadataJobRequest())->setName($formattedName); + try { + $gapicClient->cancelMetadataJob($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function createAspectTypeTest() { @@ -651,6 +720,140 @@ public function createEntryTypeExceptionTest() $this->assertTrue($operationsTransport->isExhausted()); } + /** @test */ + public function createMetadataJobTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createMetadataJobTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $name = 'name3373707'; + $uid = 'uid115792'; + $expectedResponse = new MetadataJob(); + $expectedResponse->setName($name); + $expectedResponse->setUid($uid); + $anyResponse = new Any(); + $anyResponse->setValue($expectedResponse->serializeToString()); + $completeOperation = new Operation(); + $completeOperation->setName('operations/createMetadataJobTest'); + $completeOperation->setDone(true); + $completeOperation->setResponse($anyResponse); + $operationsTransport->addResponse($completeOperation); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $metadataJob = new MetadataJob(); + $metadataJobType = Type::TYPE_UNSPECIFIED; + $metadataJob->setType($metadataJobType); + $request = (new CreateMetadataJobRequest())->setParent($formattedParent)->setMetadataJob($metadataJob); + $response = $gapicClient->createMetadataJob($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $apiRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($apiRequests)); + $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); + $this->assertSame(0, count($operationsRequestsEmpty)); + $actualApiFuncCall = $apiRequests[0]->getFuncCall(); + $actualApiRequestObject = $apiRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.dataplex.v1.CatalogService/CreateMetadataJob', $actualApiFuncCall); + $actualValue = $actualApiRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $actualValue = $actualApiRequestObject->getMetadataJob(); + $this->assertProtobufEquals($metadataJob, $actualValue); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createMetadataJobTest'); + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + $this->assertTrue($response->isDone()); + $this->assertEquals($expectedResponse, $response->getResult()); + $apiRequestsEmpty = $transport->popReceivedCalls(); + $this->assertSame(0, count($apiRequestsEmpty)); + $operationsRequests = $operationsTransport->popReceivedCalls(); + $this->assertSame(1, count($operationsRequests)); + $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); + $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); + $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); + $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + + /** @test */ + public function createMetadataJobExceptionTest() + { + $operationsTransport = $this->createTransport(); + $operationsClient = new OperationsClient([ + 'apiEndpoint' => '', + 'transport' => $operationsTransport, + 'credentials' => $this->createCredentials(), + ]); + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + 'operationsClient' => $operationsClient, + ]); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + // Mock response + $incompleteOperation = new Operation(); + $incompleteOperation->setName('operations/createMetadataJobTest'); + $incompleteOperation->setDone(false); + $transport->addResponse($incompleteOperation); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $operationsTransport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $metadataJob = new MetadataJob(); + $metadataJobType = Type::TYPE_UNSPECIFIED; + $metadataJob->setType($metadataJobType); + $request = (new CreateMetadataJobRequest())->setParent($formattedParent)->setMetadataJob($metadataJob); + $response = $gapicClient->createMetadataJob($request); + $this->assertFalse($response->isDone()); + $this->assertNull($response->getResult()); + $expectedOperationsRequestObject = new GetOperationRequest(); + $expectedOperationsRequestObject->setName('operations/createMetadataJobTest'); + try { + $response->pollUntilComplete([ + 'initialPollDelayMillis' => 1, + ]); + // If the pollUntilComplete() method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stubs are exhausted + $transport->popReceivedCalls(); + $operationsTransport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + $this->assertTrue($operationsTransport->isExhausted()); + } + /** @test */ public function deleteAspectTypeTest() { @@ -1382,6 +1585,73 @@ public function getEntryTypeExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function getMetadataJobTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $name2 = 'name2-1052831874'; + $uid = 'uid115792'; + $expectedResponse = new MetadataJob(); + $expectedResponse->setName($name2); + $expectedResponse->setUid($uid); + $transport->addResponse($expectedResponse); + // Mock request + $formattedName = $gapicClient->metadataJobName('[PROJECT]', '[LOCATION]', '[METADATAJOB]'); + $request = (new GetMetadataJobRequest())->setName($formattedName); + $response = $gapicClient->getMetadataJob($request); + $this->assertEquals($expectedResponse, $response); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.dataplex.v1.CatalogService/GetMetadataJob', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function getMetadataJobExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedName = $gapicClient->metadataJobName('[PROJECT]', '[LOCATION]', '[METADATAJOB]'); + $request = (new GetMetadataJobRequest())->setName($formattedName); + try { + $gapicClient->getMetadataJob($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function listAspectTypesTest() { @@ -1666,6 +1936,77 @@ public function listEntryTypesExceptionTest() $this->assertTrue($transport->isExhausted()); } + /** @test */ + public function listMetadataJobsTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + // Mock response + $nextPageToken = ''; + $metadataJobsElement = new MetadataJob(); + $metadataJobs = [$metadataJobsElement]; + $expectedResponse = new ListMetadataJobsResponse(); + $expectedResponse->setNextPageToken($nextPageToken); + $expectedResponse->setMetadataJobs($metadataJobs); + $transport->addResponse($expectedResponse); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListMetadataJobsRequest())->setParent($formattedParent); + $response = $gapicClient->listMetadataJobs($request); + $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); + $resources = iterator_to_array($response->iterateAllElements()); + $this->assertSame(1, count($resources)); + $this->assertEquals($expectedResponse->getMetadataJobs()[0], $resources[0]); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.dataplex.v1.CatalogService/ListMetadataJobs', $actualFuncCall); + $actualValue = $actualRequestObject->getParent(); + $this->assertProtobufEquals($formattedParent, $actualValue); + $this->assertTrue($transport->isExhausted()); + } + + /** @test */ + public function listMetadataJobsExceptionTest() + { + $transport = $this->createTransport(); + $gapicClient = $this->createClient([ + 'transport' => $transport, + ]); + $this->assertTrue($transport->isExhausted()); + $status = new stdClass(); + $status->code = Code::DATA_LOSS; + $status->details = 'internal error'; + $expectedExceptionMessage = json_encode( + [ + 'message' => 'internal error', + 'code' => Code::DATA_LOSS, + 'status' => 'DATA_LOSS', + 'details' => [], + ], + JSON_PRETTY_PRINT + ); + $transport->addResponse(null, $status); + // Mock request + $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); + $request = (new ListMetadataJobsRequest())->setParent($formattedParent); + try { + $gapicClient->listMetadataJobs($request); + // If the $gapicClient method call did not throw, fail the test + $this->fail('Expected an ApiException, but no exception was thrown.'); + } catch (ApiException $ex) { + $this->assertEquals($status->code, $ex->getCode()); + $this->assertEquals($expectedExceptionMessage, $ex->getMessage()); + } + // Call popReceivedCalls to ensure the stub is exhausted + $transport->popReceivedCalls(); + $this->assertTrue($transport->isExhausted()); + } + /** @test */ public function lookupEntryTest() { @@ -1760,9 +2101,9 @@ public function searchEntriesTest() $expectedResponse->setResults($results); $transport->addResponse($expectedResponse); // Mock request - $name = 'name3373707'; + $formattedName = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); $query = 'query107944136'; - $request = (new SearchEntriesRequest())->setName($name)->setQuery($query); + $request = (new SearchEntriesRequest())->setName($formattedName)->setQuery($query); $response = $gapicClient->searchEntries($request); $this->assertEquals($expectedResponse, $response->getPage()->getResponseObject()); $resources = iterator_to_array($response->iterateAllElements()); @@ -1774,7 +2115,7 @@ public function searchEntriesTest() $actualRequestObject = $actualRequests[0]->getRequestObject(); $this->assertSame('/google.cloud.dataplex.v1.CatalogService/SearchEntries', $actualFuncCall); $actualValue = $actualRequestObject->getName(); - $this->assertProtobufEquals($name, $actualValue); + $this->assertProtobufEquals($formattedName, $actualValue); $actualValue = $actualRequestObject->getQuery(); $this->assertProtobufEquals($query, $actualValue); $this->assertTrue($transport->isExhausted()); @@ -1802,9 +2143,9 @@ public function searchEntriesExceptionTest() ); $transport->addResponse(null, $status); // Mock request - $name = 'name3373707'; + $formattedName = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); $query = 'query107944136'; - $request = (new SearchEntriesRequest())->setName($name)->setQuery($query); + $request = (new SearchEntriesRequest())->setName($formattedName)->setQuery($query); try { $gapicClient->searchEntries($request); // If the $gapicClient method call did not throw, fail the test @@ -2651,90 +2992,27 @@ public function listLocationsExceptionTest() } /** @test */ - public function createAspectTypeAsyncTest() + public function cancelMetadataJobAsyncTest() { - $operationsTransport = $this->createTransport(); - $operationsClient = new OperationsClient([ - 'apiEndpoint' => '', - 'transport' => $operationsTransport, - 'credentials' => $this->createCredentials(), - ]); $transport = $this->createTransport(); $gapicClient = $this->createClient([ 'transport' => $transport, - 'operationsClient' => $operationsClient, ]); $this->assertTrue($transport->isExhausted()); - $this->assertTrue($operationsTransport->isExhausted()); // Mock response - $incompleteOperation = new Operation(); - $incompleteOperation->setName('operations/createAspectTypeTest'); - $incompleteOperation->setDone(false); - $transport->addResponse($incompleteOperation); - $name = 'name3373707'; - $uid = 'uid115792'; - $description = 'description-1724546052'; - $displayName = 'displayName1615086568'; - $etag = 'etag3123477'; - $expectedResponse = new AspectType(); - $expectedResponse->setName($name); - $expectedResponse->setUid($uid); - $expectedResponse->setDescription($description); - $expectedResponse->setDisplayName($displayName); - $expectedResponse->setEtag($etag); - $anyResponse = new Any(); - $anyResponse->setValue($expectedResponse->serializeToString()); - $completeOperation = new Operation(); - $completeOperation->setName('operations/createAspectTypeTest'); - $completeOperation->setDone(true); - $completeOperation->setResponse($anyResponse); - $operationsTransport->addResponse($completeOperation); + $expectedResponse = new GPBEmpty(); + $transport->addResponse($expectedResponse); // Mock request - $formattedParent = $gapicClient->locationName('[PROJECT]', '[LOCATION]'); - $aspectTypeId = 'aspectTypeId-688405671'; - $aspectType = new AspectType(); - $aspectTypeMetadataTemplate = new MetadataTemplate(); - $metadataTemplateName = 'metadataTemplateName393703156'; - $aspectTypeMetadataTemplate->setName($metadataTemplateName); - $metadataTemplateType = 'metadataTemplateType393905059'; - $aspectTypeMetadataTemplate->setType($metadataTemplateType); - $aspectType->setMetadataTemplate($aspectTypeMetadataTemplate); - $request = (new CreateAspectTypeRequest()) - ->setParent($formattedParent) - ->setAspectTypeId($aspectTypeId) - ->setAspectType($aspectType); - $response = $gapicClient->createAspectTypeAsync($request)->wait(); - $this->assertFalse($response->isDone()); - $this->assertNull($response->getResult()); - $apiRequests = $transport->popReceivedCalls(); - $this->assertSame(1, count($apiRequests)); - $operationsRequestsEmpty = $operationsTransport->popReceivedCalls(); - $this->assertSame(0, count($operationsRequestsEmpty)); - $actualApiFuncCall = $apiRequests[0]->getFuncCall(); - $actualApiRequestObject = $apiRequests[0]->getRequestObject(); - $this->assertSame('/google.cloud.dataplex.v1.CatalogService/CreateAspectType', $actualApiFuncCall); - $actualValue = $actualApiRequestObject->getParent(); - $this->assertProtobufEquals($formattedParent, $actualValue); - $actualValue = $actualApiRequestObject->getAspectTypeId(); - $this->assertProtobufEquals($aspectTypeId, $actualValue); - $actualValue = $actualApiRequestObject->getAspectType(); - $this->assertProtobufEquals($aspectType, $actualValue); - $expectedOperationsRequestObject = new GetOperationRequest(); - $expectedOperationsRequestObject->setName('operations/createAspectTypeTest'); - $response->pollUntilComplete([ - 'initialPollDelayMillis' => 1, - ]); - $this->assertTrue($response->isDone()); - $this->assertEquals($expectedResponse, $response->getResult()); - $apiRequestsEmpty = $transport->popReceivedCalls(); - $this->assertSame(0, count($apiRequestsEmpty)); - $operationsRequests = $operationsTransport->popReceivedCalls(); - $this->assertSame(1, count($operationsRequests)); - $actualOperationsFuncCall = $operationsRequests[0]->getFuncCall(); - $actualOperationsRequestObject = $operationsRequests[0]->getRequestObject(); - $this->assertSame('/google.longrunning.Operations/GetOperation', $actualOperationsFuncCall); - $this->assertEquals($expectedOperationsRequestObject, $actualOperationsRequestObject); + $formattedName = $gapicClient->metadataJobName('[PROJECT]', '[LOCATION]', '[METADATAJOB]'); + $request = (new CancelMetadataJobRequest())->setName($formattedName); + $gapicClient->cancelMetadataJobAsync($request)->wait(); + $actualRequests = $transport->popReceivedCalls(); + $this->assertSame(1, count($actualRequests)); + $actualFuncCall = $actualRequests[0]->getFuncCall(); + $actualRequestObject = $actualRequests[0]->getRequestObject(); + $this->assertSame('/google.cloud.dataplex.v1.CatalogService/CancelMetadataJob', $actualFuncCall); + $actualValue = $actualRequestObject->getName(); + $this->assertProtobufEquals($formattedName, $actualValue); $this->assertTrue($transport->isExhausted()); - $this->assertTrue($operationsTransport->isExhausted()); } }