Close httplib2 connections.
+
+ create(parent, aspectTypeId=None, body=None, validateOnly=None, x__xgafv=None)
Creates an AspectType
+
+ delete(name, etag=None, x__xgafv=None)
Deletes a AspectType resource.
+ +Retrieves a AspectType resource.
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists AspectType resources in a project and location.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates a AspectType resource.
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
@@ -92,6 +110,195 @@Close httplib2 connections.+
create(parent, aspectTypeId=None, body=None, validateOnly=None, x__xgafv=None)
+ Creates an AspectType
+
+Args:
+ parent: string, Required. The resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Aspect Type is a template for creating Aspects, and represents the JSON-schema for a given Entry, e.g., BigQuery Table Schema.
+ "authorization": { # Autorization for an Aspect Type. # Immutable. Authorization defined for this type.
+ "alternateUsePermission": "A String", # 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.
+ },
+ "createTime": "A String", # Output only. The time when the AspectType was created.
+ "description": "A String", # Optional. Description of the AspectType.
+ "displayName": "A String", # Optional. User friendly display name.
+ "etag": "A String", # 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.
+ "labels": { # Optional. User-defined labels for the AspectType.
+ "a_key": "A String",
+ },
+ "metadataTemplate": { # MetadataTemplate definition for AspectType # Required. MetadataTemplate of the aspect.
+ "annotations": { # Definition of the annotations of a field # Optional. Specifies annotations on this field.
+ "deprecated": "A String", # Optional. Marks a field as deprecated, a deprecation message can be included.
+ "description": "A String", # Optional. Specify a description for a field
+ "displayName": "A String", # Optional. Specify a displayname for a field.
+ "displayOrder": 42, # Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered
+ "stringType": "A String", # 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.
+ "stringValues": [ # Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.
+ "A String",
+ ],
+ },
+ "arrayItems": # Object with schema name: GoogleCloudDataplexV1AspectTypeMetadataTemplate # 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.
+ "constraints": { # Definition of the constraints of a field # Optional. Specifies the constraints on this field.
+ "required": True or False, # Optional. Marks this as an optional/required field.
+ },
+ "enumValues": [ # Optional. The list of values for an enum type. Needs to be defined if the type is enum.
+ { # Definition of Enumvalue (to be used by enum fields)
+ "deprecated": "A String", # Optional. Optional deprecation message to be set if an enum value needs to be deprecated.
+ "index": 42, # Required. Index for the enum. Cannot be modified.
+ "name": "A String", # Required. Name of the enumvalue. This is the actual value that the aspect will contain.
+ },
+ ],
+ "index": 42, # Optional. Index is used to encode Template messages. The value of index can range between 1 and 2,147,483,647. Index must be unique within all fields in a Template. (Nested Templates can reuse indexes). Once a Template is defined, the index cannot be changed, because it identifies the field in the actual storage format. Index is a mandatory field, but it is optional for top level fields, and map/array "values" definitions.
+ "mapItems": # Object with schema name: GoogleCloudDataplexV1AspectTypeMetadataTemplate # 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 MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.
+ "name": "A String", # Required. The name of the field.
+ "recordFields": [ # Optional. Field definition, needs to be specified if the type is record. Defines the nested fields.
+ # Object with schema name: GoogleCloudDataplexV1AspectTypeMetadataTemplate
+ ],
+ "type": "A String", # 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).
+ "typeId": "A String", # 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.
+ "typeRef": "A String", # Optional. A reference to another field definition (instead of 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 refer to other fields.
+ },
+ "name": "A String", # Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
+ "transferStatus": "A String", # Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API.
+ "uid": "A String", # 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.
+ "updateTime": "A String", # Output only. The time when the AspectType was last updated.
+}
+
+ aspectTypeId: string, Required. AspectType identifier.
+ validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+ "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+delete(name, etag=None, x__xgafv=None)
+ Deletes a AspectType resource.
+
+Args:
+ name: string, Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}. (required)
+ etag: string, Optional. If the client provided etag value does not match the current etag value, the DeleteAspectTypeRequest method returns an ABORTED error response
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+ "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+get(name, x__xgafv=None)
+ Retrieves a AspectType resource.
+
+Args:
+ name: string, Required. The resource name of the AspectType: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Aspect Type is a template for creating Aspects, and represents the JSON-schema for a given Entry, e.g., BigQuery Table Schema.
+ "authorization": { # Autorization for an Aspect Type. # Immutable. Authorization defined for this type.
+ "alternateUsePermission": "A String", # 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.
+ },
+ "createTime": "A String", # Output only. The time when the AspectType was created.
+ "description": "A String", # Optional. Description of the AspectType.
+ "displayName": "A String", # Optional. User friendly display name.
+ "etag": "A String", # 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.
+ "labels": { # Optional. User-defined labels for the AspectType.
+ "a_key": "A String",
+ },
+ "metadataTemplate": { # MetadataTemplate definition for AspectType # Required. MetadataTemplate of the aspect.
+ "annotations": { # Definition of the annotations of a field # Optional. Specifies annotations on this field.
+ "deprecated": "A String", # Optional. Marks a field as deprecated, a deprecation message can be included.
+ "description": "A String", # Optional. Specify a description for a field
+ "displayName": "A String", # Optional. Specify a displayname for a field.
+ "displayOrder": 42, # Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered
+ "stringType": "A String", # 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.
+ "stringValues": [ # Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.
+ "A String",
+ ],
+ },
+ "arrayItems": # Object with schema name: GoogleCloudDataplexV1AspectTypeMetadataTemplate # 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.
+ "constraints": { # Definition of the constraints of a field # Optional. Specifies the constraints on this field.
+ "required": True or False, # Optional. Marks this as an optional/required field.
+ },
+ "enumValues": [ # Optional. The list of values for an enum type. Needs to be defined if the type is enum.
+ { # Definition of Enumvalue (to be used by enum fields)
+ "deprecated": "A String", # Optional. Optional deprecation message to be set if an enum value needs to be deprecated.
+ "index": 42, # Required. Index for the enum. Cannot be modified.
+ "name": "A String", # Required. Name of the enumvalue. This is the actual value that the aspect will contain.
+ },
+ ],
+ "index": 42, # Optional. Index is used to encode Template messages. The value of index can range between 1 and 2,147,483,647. Index must be unique within all fields in a Template. (Nested Templates can reuse indexes). Once a Template is defined, the index cannot be changed, because it identifies the field in the actual storage format. Index is a mandatory field, but it is optional for top level fields, and map/array "values" definitions.
+ "mapItems": # Object with schema name: GoogleCloudDataplexV1AspectTypeMetadataTemplate # 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 MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.
+ "name": "A String", # Required. The name of the field.
+ "recordFields": [ # Optional. Field definition, needs to be specified if the type is record. Defines the nested fields.
+ # Object with schema name: GoogleCloudDataplexV1AspectTypeMetadataTemplate
+ ],
+ "type": "A String", # 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).
+ "typeId": "A String", # 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.
+ "typeRef": "A String", # Optional. A reference to another field definition (instead of 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 refer to other fields.
+ },
+ "name": "A String", # Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
+ "transferStatus": "A String", # Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API.
+ "uid": "A String", # 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.
+ "updateTime": "A String", # Output only. The time when the AspectType was last updated.
+}
+getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. @@ -140,6 +347,185 @@Method Details
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists AspectType resources in a project and location.
+
+Args:
+ parent: string, 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. (required)
+ filter: string, 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.
+ orderBy: string, Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.
+ pageSize: integer, 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.
+ pageToken: string, 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.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # List AspectTypes response
+ "aspectTypes": [ # ListAspectTypes under the given parent location.
+ { # Aspect Type is a template for creating Aspects, and represents the JSON-schema for a given Entry, e.g., BigQuery Table Schema.
+ "authorization": { # Autorization for an Aspect Type. # Immutable. Authorization defined for this type.
+ "alternateUsePermission": "A String", # 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.
+ },
+ "createTime": "A String", # Output only. The time when the AspectType was created.
+ "description": "A String", # Optional. Description of the AspectType.
+ "displayName": "A String", # Optional. User friendly display name.
+ "etag": "A String", # 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.
+ "labels": { # Optional. User-defined labels for the AspectType.
+ "a_key": "A String",
+ },
+ "metadataTemplate": { # MetadataTemplate definition for AspectType # Required. MetadataTemplate of the aspect.
+ "annotations": { # Definition of the annotations of a field # Optional. Specifies annotations on this field.
+ "deprecated": "A String", # Optional. Marks a field as deprecated, a deprecation message can be included.
+ "description": "A String", # Optional. Specify a description for a field
+ "displayName": "A String", # Optional. Specify a displayname for a field.
+ "displayOrder": 42, # Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered
+ "stringType": "A String", # 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.
+ "stringValues": [ # Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.
+ "A String",
+ ],
+ },
+ "arrayItems": # Object with schema name: GoogleCloudDataplexV1AspectTypeMetadataTemplate # 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.
+ "constraints": { # Definition of the constraints of a field # Optional. Specifies the constraints on this field.
+ "required": True or False, # Optional. Marks this as an optional/required field.
+ },
+ "enumValues": [ # Optional. The list of values for an enum type. Needs to be defined if the type is enum.
+ { # Definition of Enumvalue (to be used by enum fields)
+ "deprecated": "A String", # Optional. Optional deprecation message to be set if an enum value needs to be deprecated.
+ "index": 42, # Required. Index for the enum. Cannot be modified.
+ "name": "A String", # Required. Name of the enumvalue. This is the actual value that the aspect will contain.
+ },
+ ],
+ "index": 42, # Optional. Index is used to encode Template messages. The value of index can range between 1 and 2,147,483,647. Index must be unique within all fields in a Template. (Nested Templates can reuse indexes). Once a Template is defined, the index cannot be changed, because it identifies the field in the actual storage format. Index is a mandatory field, but it is optional for top level fields, and map/array "values" definitions.
+ "mapItems": # Object with schema name: GoogleCloudDataplexV1AspectTypeMetadataTemplate # 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 MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.
+ "name": "A String", # Required. The name of the field.
+ "recordFields": [ # Optional. Field definition, needs to be specified if the type is record. Defines the nested fields.
+ # Object with schema name: GoogleCloudDataplexV1AspectTypeMetadataTemplate
+ ],
+ "type": "A String", # 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).
+ "typeId": "A String", # 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.
+ "typeRef": "A String", # Optional. A reference to another field definition (instead of 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 refer to other fields.
+ },
+ "name": "A String", # Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
+ "transferStatus": "A String", # Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API.
+ "uid": "A String", # 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.
+ "updateTime": "A String", # Output only. The time when the AspectType was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+ "unreachableLocations": [ # Locations that could not be reached.
+ "A String",
+ ],
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)
+ Updates a AspectType resource.
+
+Args:
+ name: string, Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Aspect Type is a template for creating Aspects, and represents the JSON-schema for a given Entry, e.g., BigQuery Table Schema.
+ "authorization": { # Autorization for an Aspect Type. # Immutable. Authorization defined for this type.
+ "alternateUsePermission": "A String", # 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.
+ },
+ "createTime": "A String", # Output only. The time when the AspectType was created.
+ "description": "A String", # Optional. Description of the AspectType.
+ "displayName": "A String", # Optional. User friendly display name.
+ "etag": "A String", # 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.
+ "labels": { # Optional. User-defined labels for the AspectType.
+ "a_key": "A String",
+ },
+ "metadataTemplate": { # MetadataTemplate definition for AspectType # Required. MetadataTemplate of the aspect.
+ "annotations": { # Definition of the annotations of a field # Optional. Specifies annotations on this field.
+ "deprecated": "A String", # Optional. Marks a field as deprecated, a deprecation message can be included.
+ "description": "A String", # Optional. Specify a description for a field
+ "displayName": "A String", # Optional. Specify a displayname for a field.
+ "displayOrder": 42, # Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered
+ "stringType": "A String", # 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.
+ "stringValues": [ # Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.
+ "A String",
+ ],
+ },
+ "arrayItems": # Object with schema name: GoogleCloudDataplexV1AspectTypeMetadataTemplate # 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.
+ "constraints": { # Definition of the constraints of a field # Optional. Specifies the constraints on this field.
+ "required": True or False, # Optional. Marks this as an optional/required field.
+ },
+ "enumValues": [ # Optional. The list of values for an enum type. Needs to be defined if the type is enum.
+ { # Definition of Enumvalue (to be used by enum fields)
+ "deprecated": "A String", # Optional. Optional deprecation message to be set if an enum value needs to be deprecated.
+ "index": 42, # Required. Index for the enum. Cannot be modified.
+ "name": "A String", # Required. Name of the enumvalue. This is the actual value that the aspect will contain.
+ },
+ ],
+ "index": 42, # Optional. Index is used to encode Template messages. The value of index can range between 1 and 2,147,483,647. Index must be unique within all fields in a Template. (Nested Templates can reuse indexes). Once a Template is defined, the index cannot be changed, because it identifies the field in the actual storage format. Index is a mandatory field, but it is optional for top level fields, and map/array "values" definitions.
+ "mapItems": # Object with schema name: GoogleCloudDataplexV1AspectTypeMetadataTemplate # 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 MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload.
+ "name": "A String", # Required. The name of the field.
+ "recordFields": [ # Optional. Field definition, needs to be specified if the type is record. Defines the nested fields.
+ # Object with schema name: GoogleCloudDataplexV1AspectTypeMetadataTemplate
+ ],
+ "type": "A String", # 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).
+ "typeId": "A String", # 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.
+ "typeRef": "A String", # Optional. A reference to another field definition (instead of 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 refer to other fields.
+ },
+ "name": "A String", # Output only. The relative resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}.
+ "transferStatus": "A String", # Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API.
+ "uid": "A String", # 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.
+ "updateTime": "A String", # Output only. The time when the AspectType was last updated.
+}
+
+ updateMask: string, Required. Mask of fields to update.
+ validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+ "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html index 2d6d6e53b1..0ee5b0057a 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html @@ -88,6 +88,9 @@Instance Methods
Deletes a DataScan resource.
++
+generateDataQualityRules(name, body=None, x__xgafv=None)Generates recommended DataQualityRule from a data profiling DataScan.
get(name, view=None, x__xgafv=None)Gets a DataScan resource.
@@ -133,6 +136,16 @@Method Details
"entity": "A String", # Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could be: BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID }, + "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of the data documentation scan. + "queries": [ # Output only. The list of generated queries. + { # A query in data documentation + "description": "A String", # Output only. The description for the query. + "sql": "A String", # Output only. The SQL query string which can be executed. + }, + ], + }, + "dataDocumentationSpec": { # DataDocumentation scan related spec. # DataDocumentationScan related setting. + }, "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan. "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions. "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action. @@ -449,6 +462,71 @@Method Details
}
generateDataQualityRules(name, body=None, x__xgafv=None)
+ Generates recommended DataQualityRule from a data profiling DataScan.
+
+Args:
+ name: string, Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Generate recommended DataQualityRules request.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Generate recommended DataQualityRules response.
+ "rule": [ # Generated recommended {@link DataQualityRule}s.
+ { # A rule captures data quality intent about a data source.
+ "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+ "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
+ "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+ "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
+ "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
+ "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
+ },
+ "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # Row-level rule which evaluates whether each column value lies between a specified range.
+ "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+ "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+ "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.
+ "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.
+ },
+ "regexExpectation": { # Evaluates whether each column value matches a specified regex. # Row-level rule which evaluates whether each column value matches a specified regex.
+ "regex": "A String", # Optional. A regular expression the column value is expected to match.
+ },
+ "rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition.
+ "sqlExpression": "A String", # Optional. The SQL expression.
+ },
+ "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set.
+ "values": [ # Optional. Expected values for the column value.
+ "A String",
+ ],
+ },
+ "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+ "maxValue": "A String", # Optional. The maximum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.
+ "minValue": "A String", # Optional. The minimum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.
+ "statistic": "A String", # Optional. The aggregate metric to evaluate.
+ "strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.
+ "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.
+ },
+ "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table.
+ "sqlExpression": "A String", # Optional. The SQL expression.
+ },
+ "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules.
+ "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique.
+ },
+ },
+ ],
+}
+get(name, view=None, x__xgafv=None)
Gets a DataScan resource. @@ -474,6 +552,16 @@Method Details
"entity": "A String", # Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could be: BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID }, + "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of the data documentation scan. + "queries": [ # Output only. The list of generated queries. + { # A query in data documentation + "description": "A String", # Output only. The description for the query. + "sql": "A String", # Output only. The SQL query string which can be executed. + }, + ], + }, + "dataDocumentationSpec": { # DataDocumentation scan related spec. # DataDocumentationScan related setting. + }, "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan. "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions. "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action. @@ -799,6 +887,16 @@Method Details
"entity": "A String", # Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could be: BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID }, + "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of the data documentation scan. + "queries": [ # Output only. The list of generated queries. + { # A query in data documentation + "description": "A String", # Output only. The description for the query. + "sql": "A String", # Output only. The SQL query string which can be executed. + }, + ], + }, + "dataDocumentationSpec": { # DataDocumentation scan related spec. # DataDocumentationScan related setting. + }, "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan. "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions. "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action. @@ -1085,6 +1183,16 @@Method Details
"entity": "A String", # Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could be: BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID }, + "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of the data documentation scan. + "queries": [ # Output only. The list of generated queries. + { # A query in data documentation + "description": "A String", # Output only. The description for the query. + "sql": "A String", # Output only. The SQL query string which can be executed. + }, + ], + }, + "dataDocumentationSpec": { # DataDocumentation scan related spec. # DataDocumentationScan related setting. + }, "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan. "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions. "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action. @@ -1388,6 +1496,16 @@Method Details
{ # Run DataScan Response. "job": { # A DataScanJob represents an instance of DataScan execution. # DataScanJob created by RunDataScan request. + "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of the data documentation scan. + "queries": [ # Output only. The list of generated queries. + { # A query in data documentation + "description": "A String", # Output only. The description for the query. + "sql": "A String", # Output only. The SQL query string which can be executed. + }, + ], + }, + "dataDocumentationSpec": { # DataDocumentation scan related spec. # Output only. DataDocumentationScan related setting. + }, "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan. "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions. "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action. diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html index e709ef8380..ee5b0389ae 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html @@ -77,6 +77,9 @@Instance Methods
Close httplib2 connections.
++
+generateDataQualityRules(name, body=None, x__xgafv=None)Generates recommended DataQualityRule from a data profiling DataScan.
get(name, view=None, x__xgafv=None)Gets a DataScanJob resource.
@@ -92,6 +95,71 @@Method Details
Close httplib2 connections.
generateDataQualityRules(name, body=None, x__xgafv=None)
+ Generates recommended DataQualityRule from a data profiling DataScan.
+
+Args:
+ name: string, Required. The name should be either * the name of a datascan with at least one successful completed data profiling job, or * the name of a successful completed data profiling datascan job. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Generate recommended DataQualityRules request.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Generate recommended DataQualityRules response.
+ "rule": [ # Generated recommended {@link DataQualityRule}s.
+ { # A rule captures data quality intent about a data source.
+ "column": "A String", # Optional. The unnested column which this rule is evaluated against.
+ "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters.
+ "dimension": "A String", # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
+ "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
+ "name": "A String", # Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter. Must end with a number or a letter.
+ "nonNullExpectation": { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
+ },
+ "rangeExpectation": { # Evaluates whether each column value lies between a specified range. # Row-level rule which evaluates whether each column value lies between a specified range.
+ "maxValue": "A String", # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+ "minValue": "A String", # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+ "strictMaxEnabled": True or False, # Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.
+ "strictMinEnabled": True or False, # Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.
+ },
+ "regexExpectation": { # Evaluates whether each column value matches a specified regex. # Row-level rule which evaluates whether each column value matches a specified regex.
+ "regex": "A String", # Optional. A regular expression the column value is expected to match.
+ },
+ "rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition.
+ "sqlExpression": "A String", # Optional. The SQL expression.
+ },
+ "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set.
+ "values": [ # Optional. Expected values for the column value.
+ "A String",
+ ],
+ },
+ "statisticRangeExpectation": { # Evaluates whether the column aggregate statistic lies between a specified range. # Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range.
+ "maxValue": "A String", # Optional. The maximum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.
+ "minValue": "A String", # Optional. The minimum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.
+ "statistic": "A String", # Optional. The aggregate metric to evaluate.
+ "strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.
+ "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.
+ },
+ "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table.
+ "sqlExpression": "A String", # Optional. The SQL expression.
+ },
+ "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules.
+ "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique.
+ },
+ },
+ ],
+}
+get(name, view=None, x__xgafv=None)
Gets a DataScanJob resource. @@ -112,6 +180,16 @@Method Details
An object of the form: { # A DataScanJob represents an instance of DataScan execution. + "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of the data documentation scan. + "queries": [ # Output only. The list of generated queries. + { # A query in data documentation + "description": "A String", # Output only. The description for the query. + "sql": "A String", # Output only. The SQL query string which can be executed. + }, + ], + }, + "dataDocumentationSpec": { # DataDocumentation scan related spec. # Output only. DataDocumentationScan related setting. + }, "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan. "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions. "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action. @@ -366,6 +444,16 @@Method Details
{ # List DataScanJobs response. "dataScanJobs": [ # DataScanJobs (BASIC view only) under a given dataScan. { # A DataScanJob represents an instance of DataScan execution. + "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of the data documentation scan. + "queries": [ # Output only. The list of generated queries. + { # A query in data documentation + "description": "A String", # Output only. The description for the query. + "sql": "A String", # Output only. The SQL query string which can be executed. + }, + ], + }, + "dataDocumentationSpec": { # DataDocumentation scan related spec. # Output only. DataDocumentationScan related setting. + }, "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan. "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions. "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action. diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html new file mode 100644 index 0000000000..9e3cb7dbad --- /dev/null +++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html @@ -0,0 +1,515 @@ + + + +Cloud Dataplex API . projects . locations . entryGroups . entries
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, body=None, entryId=None, x__xgafv=None)Creates an Entry.
+ +Deletes an Entry.
++
+get(name, aspectTypes=None, paths=None, view=None, x__xgafv=None)Gets a single entry.
++
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists entries within an entry group.
+ +Retrieves the next page of results.
+ +Updates an Entry.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, entryId=None, x__xgafv=None)+Creates an Entry. + +Args: + parent: string, Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. (required) + body: object, The request body. + The object takes the form of: + +{ # An entry is a representation of a data asset which can be described by various metadata. + "aspects": { # Optional. The Aspects attached to the Entry. The key is either the resource name of the aspect type (if the aspect is attached directly to the entry) or "aspectType@path" if the aspect is attached to an entry's path. + "a_key": { # An aspect is a single piece of metadata describing an entry. + "aspectSource": { # AspectSource contains source system related information for the aspect. + "createTime": "A String", # The create time of the aspect in the source system. + "updateTime": "A String", # The update time of the aspect in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "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). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry was created. + "entrySource": { # EntrySource contains source system related information for the entry. # Optional. Source system related information for an entry. + "ancestors": [ # Immutable. The ancestors of the Entry in the source system. + { # Ancestor contains information about individual items in the hierarchy of an Entry. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The create time of the resource in the source system. + "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. + "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. + "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. + "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. + "updateTime": "A String", # The update time of the resource in the source system. + }, + "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "updateTime": "A String", # Output only. The time when the Entry was last updated. +} + + entryId: string, 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 //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 Cloud.The maximum size of the field is 4000 characters. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An entry is a representation of a data asset which can be described by various metadata. + "aspects": { # Optional. The Aspects attached to the Entry. The key is either the resource name of the aspect type (if the aspect is attached directly to the entry) or "aspectType@path" if the aspect is attached to an entry's path. + "a_key": { # An aspect is a single piece of metadata describing an entry. + "aspectSource": { # AspectSource contains source system related information for the aspect. + "createTime": "A String", # The create time of the aspect in the source system. + "updateTime": "A String", # The update time of the aspect in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "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). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry was created. + "entrySource": { # EntrySource contains source system related information for the entry. # Optional. Source system related information for an entry. + "ancestors": [ # Immutable. The ancestors of the Entry in the source system. + { # Ancestor contains information about individual items in the hierarchy of an Entry. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The create time of the resource in the source system. + "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. + "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. + "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. + "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. + "updateTime": "A String", # The update time of the resource in the source system. + }, + "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "updateTime": "A String", # Output only. The time when the Entry was last updated. +}+++ +delete(name, x__xgafv=None)+Deletes an Entry. + +Args: + name: string, Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An entry is a representation of a data asset which can be described by various metadata. + "aspects": { # Optional. The Aspects attached to the Entry. The key is either the resource name of the aspect type (if the aspect is attached directly to the entry) or "aspectType@path" if the aspect is attached to an entry's path. + "a_key": { # An aspect is a single piece of metadata describing an entry. + "aspectSource": { # AspectSource contains source system related information for the aspect. + "createTime": "A String", # The create time of the aspect in the source system. + "updateTime": "A String", # The update time of the aspect in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "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). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry was created. + "entrySource": { # EntrySource contains source system related information for the entry. # Optional. Source system related information for an entry. + "ancestors": [ # Immutable. The ancestors of the Entry in the source system. + { # Ancestor contains information about individual items in the hierarchy of an Entry. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The create time of the resource in the source system. + "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. + "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. + "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. + "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. + "updateTime": "A String", # The update time of the resource in the source system. + }, + "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "updateTime": "A String", # Output only. The time when the Entry was last updated. +}+++ +get(name, aspectTypes=None, paths=None, view=None, x__xgafv=None)+Gets a single entry. + +Args: + name: string, Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. (required) + aspectTypes: string, Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected. (repeated) + paths: string, Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected. (repeated) + view: string, Optional. View for controlling which parts of an entry are to be returned. + Allowed values + ENTRY_VIEW_UNSPECIFIED - Unspecified EntryView. Defaults to FULL. + BASIC - Returns entry only, without aspects. + FULL - Returns all required aspects as well as the keys of all non-required aspects. + CUSTOM - Returns aspects matching custom fields in GetEntryRequest. If the number of aspects would exceed 100, the first 100 will be returned. + ALL - Returns all aspects. If the number of aspects would exceed 100, the first 100 will be returned. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An entry is a representation of a data asset which can be described by various metadata. + "aspects": { # Optional. The Aspects attached to the Entry. The key is either the resource name of the aspect type (if the aspect is attached directly to the entry) or "aspectType@path" if the aspect is attached to an entry's path. + "a_key": { # An aspect is a single piece of metadata describing an entry. + "aspectSource": { # AspectSource contains source system related information for the aspect. + "createTime": "A String", # The create time of the aspect in the source system. + "updateTime": "A String", # The update time of the aspect in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "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). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry was created. + "entrySource": { # EntrySource contains source system related information for the entry. # Optional. Source system related information for an entry. + "ancestors": [ # Immutable. The ancestors of the Entry in the source system. + { # Ancestor contains information about individual items in the hierarchy of an Entry. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The create time of the resource in the source system. + "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. + "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. + "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. + "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. + "updateTime": "A String", # The update time of the resource in the source system. + }, + "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "updateTime": "A String", # Output only. The time when the Entry was last updated. +}+++ +list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)+Lists entries within an entry group. + +Args: + parent: string, Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. (required) + filter: string, Optional. A filter on the entries to return. Filters are case-sensitive. The request can be filtered by the following fields: entry_type, 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. Example filter expressions: "display_name=AnExampleDisplayName" "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" "entry_type=projects/a* OR "entry_type=projects/k*" "NOT display_name=AnotherExampleDisplayName" + pageSize: integer, A parameter + pageToken: string, Optional. The pagination token returned by a previous request. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { + "entries": [ # The list of entries. + { # An entry is a representation of a data asset which can be described by various metadata. + "aspects": { # Optional. The Aspects attached to the Entry. The key is either the resource name of the aspect type (if the aspect is attached directly to the entry) or "aspectType@path" if the aspect is attached to an entry's path. + "a_key": { # An aspect is a single piece of metadata describing an entry. + "aspectSource": { # AspectSource contains source system related information for the aspect. + "createTime": "A String", # The create time of the aspect in the source system. + "updateTime": "A String", # The update time of the aspect in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "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). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry was created. + "entrySource": { # EntrySource contains source system related information for the entry. # Optional. Source system related information for an entry. + "ancestors": [ # Immutable. The ancestors of the Entry in the source system. + { # Ancestor contains information about individual items in the hierarchy of an Entry. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The create time of the resource in the source system. + "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. + "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. + "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. + "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. + "updateTime": "A String", # The update time of the resource in the source system. + }, + "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "updateTime": "A String", # Output only. The time when the Entry was last updated. + }, + ], + "nextPageToken": "A String", # Pagination token. +}+++ +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++++ + \ No newline at end of file diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.html index e7d6dd32ee..b62c6c6a46 100644 --- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.html +++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.html @@ -74,12 +74,35 @@patch(name, allowMissing=None, aspectKeys=None, body=None, deleteMissingAspects=None, updateMask=None, x__xgafv=None)+Updates an Entry. + +Args: + name: string, Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. (required) + body: object, The request body. + The object takes the form of: + +{ # An entry is a representation of a data asset which can be described by various metadata. + "aspects": { # Optional. The Aspects attached to the Entry. The key is either the resource name of the aspect type (if the aspect is attached directly to the entry) or "aspectType@path" if the aspect is attached to an entry's path. + "a_key": { # An aspect is a single piece of metadata describing an entry. + "aspectSource": { # AspectSource contains source system related information for the aspect. + "createTime": "A String", # The create time of the aspect in the source system. + "updateTime": "A String", # The update time of the aspect in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "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). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry was created. + "entrySource": { # EntrySource contains source system related information for the entry. # Optional. Source system related information for an entry. + "ancestors": [ # Immutable. The ancestors of the Entry in the source system. + { # Ancestor contains information about individual items in the hierarchy of an Entry. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The create time of the resource in the source system. + "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. + "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. + "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. + "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. + "updateTime": "A String", # The update time of the resource in the source system. + }, + "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "updateTime": "A String", # Output only. The time when the Entry was last updated. +} + + allowMissing: boolean, Optional. If set to true and the entry does not exist, it will be created. + aspectKeys: string, 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 pathExisting aspects matching the syntax will not be removed 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. (repeated) + deleteMissingAspects: boolean, 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. + updateMask: string, 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. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An entry is a representation of a data asset which can be described by various metadata. + "aspects": { # Optional. The Aspects attached to the Entry. The key is either the resource name of the aspect type (if the aspect is attached directly to the entry) or "aspectType@path" if the aspect is attached to an entry's path. + "a_key": { # An aspect is a single piece of metadata describing an entry. + "aspectSource": { # AspectSource contains source system related information for the aspect. + "createTime": "A String", # The create time of the aspect in the source system. + "updateTime": "A String", # The update time of the aspect in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "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). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry was created. + "entrySource": { # EntrySource contains source system related information for the entry. # Optional. Source system related information for an entry. + "ancestors": [ # Immutable. The ancestors of the Entry in the source system. + { # Ancestor contains information about individual items in the hierarchy of an Entry. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The create time of the resource in the source system. + "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. + "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. + "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. + "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. + "updateTime": "A String", # The update time of the resource in the source system. + }, + "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "updateTime": "A String", # Output only. The time when the Entry was last updated. +}+Cloud Dataplex API . projects . locations . entryGroups
Instance Methods
++
+entries()+Returns the entries Resource.
+Close httplib2 connections.
++
+create(parent, body=None, entryGroupId=None, validateOnly=None, x__xgafv=None)Creates an EntryGroup
++
+delete(name, etag=None, x__xgafv=None)Deletes a EntryGroup resource.
+ +Retrieves a EntryGroup resource.
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
++
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)Lists EntryGroup resources in a project and location.
+ +Retrieves the next page of results.
++
+patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)Updates a EntryGroup resource.
setIamPolicy(resource, body=None, x__xgafv=None)Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
@@ -92,6 +115,125 @@Method Details
Close httplib2 connections.
create(parent, body=None, entryGroupId=None, validateOnly=None, x__xgafv=None)
+ Creates an EntryGroup
+
+Args:
+ parent: string, Required. The resource name of the entryGroup, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # An Entry Group represents a logical grouping of one or more Entries.
+ "createTime": "A String", # Output only. The time when the EntryGroup was created.
+ "description": "A String", # Optional. Description of the EntryGroup.
+ "displayName": "A String", # Optional. User friendly display name.
+ "etag": "A String", # 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.
+ "labels": { # Optional. User-defined labels for the EntryGroup.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+ "transferStatus": "A String", # Output only. Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API.
+ "uid": "A String", # 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.
+ "updateTime": "A String", # Output only. The time when the EntryGroup was last updated.
+}
+
+ entryGroupId: string, Required. EntryGroup identifier.
+ validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+ "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+delete(name, etag=None, x__xgafv=None)
+ Deletes a EntryGroup resource.
+
+Args:
+ name: string, Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. (required)
+ etag: string, Optional. If the client provided etag value does not match the current etag value, the DeleteEntryGroupRequest method returns an ABORTED error response
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+ "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+get(name, x__xgafv=None)
+ Retrieves a EntryGroup resource.
+
+Args:
+ name: string, Required. The resource name of the EntryGroup: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Entry Group represents a logical grouping of one or more Entries.
+ "createTime": "A String", # Output only. The time when the EntryGroup was created.
+ "description": "A String", # Optional. Description of the EntryGroup.
+ "displayName": "A String", # Optional. User friendly display name.
+ "etag": "A String", # 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.
+ "labels": { # Optional. User-defined labels for the EntryGroup.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+ "transferStatus": "A String", # Output only. Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API.
+ "uid": "A String", # 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.
+ "updateTime": "A String", # Output only. The time when the EntryGroup was last updated.
+}
+getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. @@ -140,6 +282,115 @@Method Details
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists EntryGroup resources in a project and location.
+
+Args:
+ parent: string, 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. (required)
+ filter: string, Optional. Filter request.
+ orderBy: string, Optional. Order by fields for the result.
+ pageSize: integer, 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.
+ pageToken: string, 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.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # List ListEntryGroups response.
+ "entryGroups": [ # ListEntryGroups under the given parent location.
+ { # An Entry Group represents a logical grouping of one or more Entries.
+ "createTime": "A String", # Output only. The time when the EntryGroup was created.
+ "description": "A String", # Optional. Description of the EntryGroup.
+ "displayName": "A String", # Optional. User friendly display name.
+ "etag": "A String", # 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.
+ "labels": { # Optional. User-defined labels for the EntryGroup.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+ "transferStatus": "A String", # Output only. Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API.
+ "uid": "A String", # 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.
+ "updateTime": "A String", # Output only. The time when the EntryGroup was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+ "unreachableLocations": [ # Locations that could not be reached.
+ "A String",
+ ],
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)
+ Updates a EntryGroup resource.
+
+Args:
+ name: string, Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # An Entry Group represents a logical grouping of one or more Entries.
+ "createTime": "A String", # Output only. The time when the EntryGroup was created.
+ "description": "A String", # Optional. Description of the EntryGroup.
+ "displayName": "A String", # Optional. User friendly display name.
+ "etag": "A String", # 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.
+ "labels": { # Optional. User-defined labels for the EntryGroup.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+ "transferStatus": "A String", # Output only. Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API.
+ "uid": "A String", # 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.
+ "updateTime": "A String", # Output only. The time when the EntryGroup was last updated.
+}
+
+ updateMask: string, Required. Mask of fields to update.
+ validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+ "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. diff --git a/docs/dyn/dataplex_v1.projects.locations.entryTypes.html b/docs/dyn/dataplex_v1.projects.locations.entryTypes.html index 008055d377..d0fed358cd 100644 --- a/docs/dyn/dataplex_v1.projects.locations.entryTypes.html +++ b/docs/dyn/dataplex_v1.projects.locations.entryTypes.html @@ -77,9 +77,27 @@Instance Methods
Close httplib2 connections.
++
+create(parent, body=None, entryTypeId=None, validateOnly=None, x__xgafv=None)Creates an EntryType
++
+delete(name, etag=None, x__xgafv=None)Deletes a EntryType resource.
+ +Retrieves a EntryType resource.
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
++
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)Lists EntryType resources in a project and location.
+ +Retrieves the next page of results.
++
+patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)Updates a EntryType resource.
setIamPolicy(resource, body=None, x__xgafv=None)Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
@@ -92,6 +110,149 @@Method Details
Close httplib2 connections.
create(parent, body=None, entryTypeId=None, validateOnly=None, x__xgafv=None)
+ Creates an EntryType
+
+Args:
+ parent: string, Required. The resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Entry Type is a template for creating Entries.
+ "authorization": { # Authorization for an Entry Type. # Immutable. Authorization defined for this type.
+ "alternateUsePermission": "A String", # Immutable. The IAM permission grantable on the Entry Group to allow access to instantiate Entries of Dataplex owned Entry Types, only settable for Dataplex owned Types.
+ },
+ "createTime": "A String", # Output only. The time when the EntryType was created.
+ "description": "A String", # Optional. Description of the EntryType.
+ "displayName": "A String", # Optional. User friendly display name.
+ "etag": "A String", # 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.
+ "labels": { # Optional. User-defined labels for the EntryType.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "platform": "A String", # Optional. The platform that Entries of this type belongs to.
+ "requiredAspects": [ # AspectInfo for the entry type.
+ {
+ "type": "A String", # Required aspect type for the entry type.
+ },
+ ],
+ "system": "A String", # Optional. The system that Entries of this type belongs to. Examples include CloudSQL, MariaDB etc
+ "typeAliases": [ # Optional. Indicates the class this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.
+ "A String",
+ ],
+ "uid": "A String", # Output only. System generated globally unique ID for the EntryType. This ID will be different if the EntryType is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time when the EntryType was last updated.
+}
+
+ entryTypeId: string, Required. EntryType identifier.
+ validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+ "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+delete(name, etag=None, x__xgafv=None)
+ Deletes a EntryType resource.
+
+Args:
+ name: string, Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}. (required)
+ etag: string, Optional. If the client provided etag value does not match the current etag value, the DeleteEntryTypeRequest method returns an ABORTED error response
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+ "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+get(name, x__xgafv=None)
+ Retrieves a EntryType resource.
+
+Args:
+ name: string, Required. The resource name of the EntryType: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Entry Type is a template for creating Entries.
+ "authorization": { # Authorization for an Entry Type. # Immutable. Authorization defined for this type.
+ "alternateUsePermission": "A String", # Immutable. The IAM permission grantable on the Entry Group to allow access to instantiate Entries of Dataplex owned Entry Types, only settable for Dataplex owned Types.
+ },
+ "createTime": "A String", # Output only. The time when the EntryType was created.
+ "description": "A String", # Optional. Description of the EntryType.
+ "displayName": "A String", # Optional. User friendly display name.
+ "etag": "A String", # 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.
+ "labels": { # Optional. User-defined labels for the EntryType.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "platform": "A String", # Optional. The platform that Entries of this type belongs to.
+ "requiredAspects": [ # AspectInfo for the entry type.
+ {
+ "type": "A String", # Required aspect type for the entry type.
+ },
+ ],
+ "system": "A String", # Optional. The system that Entries of this type belongs to. Examples include CloudSQL, MariaDB etc
+ "typeAliases": [ # Optional. Indicates the class this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.
+ "A String",
+ ],
+ "uid": "A String", # Output only. System generated globally unique ID for the EntryType. This ID will be different if the EntryType is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time when the EntryType was last updated.
+}
+getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. @@ -140,6 +301,139 @@Method Details
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists EntryType resources in a project and location.
+
+Args:
+ parent: string, 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. (required)
+ filter: string, 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.
+ orderBy: string, Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.
+ pageSize: integer, 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 1000.
+ pageToken: string, 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.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # List EntryTypes response
+ "entryTypes": [ # ListEntryTypes under the given parent location.
+ { # Entry Type is a template for creating Entries.
+ "authorization": { # Authorization for an Entry Type. # Immutable. Authorization defined for this type.
+ "alternateUsePermission": "A String", # Immutable. The IAM permission grantable on the Entry Group to allow access to instantiate Entries of Dataplex owned Entry Types, only settable for Dataplex owned Types.
+ },
+ "createTime": "A String", # Output only. The time when the EntryType was created.
+ "description": "A String", # Optional. Description of the EntryType.
+ "displayName": "A String", # Optional. User friendly display name.
+ "etag": "A String", # 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.
+ "labels": { # Optional. User-defined labels for the EntryType.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "platform": "A String", # Optional. The platform that Entries of this type belongs to.
+ "requiredAspects": [ # AspectInfo for the entry type.
+ {
+ "type": "A String", # Required aspect type for the entry type.
+ },
+ ],
+ "system": "A String", # Optional. The system that Entries of this type belongs to. Examples include CloudSQL, MariaDB etc
+ "typeAliases": [ # Optional. Indicates the class this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.
+ "A String",
+ ],
+ "uid": "A String", # Output only. System generated globally unique ID for the EntryType. This ID will be different if the EntryType is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time when the EntryType was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+ "unreachableLocations": [ # Locations that could not be reached.
+ "A String",
+ ],
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)
+ Updates a EntryType resource.
+
+Args:
+ name: string, Output only. The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Entry Type is a template for creating Entries.
+ "authorization": { # Authorization for an Entry Type. # Immutable. Authorization defined for this type.
+ "alternateUsePermission": "A String", # Immutable. The IAM permission grantable on the Entry Group to allow access to instantiate Entries of Dataplex owned Entry Types, only settable for Dataplex owned Types.
+ },
+ "createTime": "A String", # Output only. The time when the EntryType was created.
+ "description": "A String", # Optional. Description of the EntryType.
+ "displayName": "A String", # Optional. User friendly display name.
+ "etag": "A String", # 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.
+ "labels": { # Optional. User-defined labels for the EntryType.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The relative resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "platform": "A String", # Optional. The platform that Entries of this type belongs to.
+ "requiredAspects": [ # AspectInfo for the entry type.
+ {
+ "type": "A String", # Required aspect type for the entry type.
+ },
+ ],
+ "system": "A String", # Optional. The system that Entries of this type belongs to. Examples include CloudSQL, MariaDB etc
+ "typeAliases": [ # Optional. Indicates the class this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.
+ "A String",
+ ],
+ "uid": "A String", # Output only. System generated globally unique ID for the EntryType. This ID will be different if the EntryType is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time when the EntryType was last updated.
+}
+
+ updateMask: string, Required. Mask of fields to update.
+ validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+ "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html index 04d38def68..c304dbecdf 100644 --- a/docs/dyn/dataplex_v1.projects.locations.html +++ b/docs/dyn/dataplex_v1.projects.locations.html @@ -131,6 +131,15 @@Instance Methods
Retrieves the next page of results.
++
+lookupEntry(name, aspectTypes=None, entry=None, paths=None, view=None, x__xgafv=None)Looks up a single entry.
+ +Searches for entries matching given query and scope.
+ +Retrieves the next page of results.
Method Details
+close()@@ -213,4 +222,209 @@Method Details
++ +lookupEntry(name, aspectTypes=None, entry=None, paths=None, view=None, x__xgafv=None)+Looks up a single entry. + +Args: + name: string, Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}. (required) + aspectTypes: string, Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected. (repeated) + entry: string, Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + paths: string, Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected. (repeated) + view: string, Optional. View for controlling which parts of an entry are to be returned. + Allowed values + ENTRY_VIEW_UNSPECIFIED - Unspecified EntryView. Defaults to FULL. + BASIC - Returns entry only, without aspects. + FULL - Returns all required aspects as well as the keys of all non-required aspects. + CUSTOM - Returns aspects matching custom fields in GetEntryRequest. If the number of aspects would exceed 100, the first 100 will be returned. + ALL - Returns all aspects. If the number of aspects would exceed 100, the first 100 will be returned. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An entry is a representation of a data asset which can be described by various metadata. + "aspects": { # Optional. The Aspects attached to the Entry. The key is either the resource name of the aspect type (if the aspect is attached directly to the entry) or "aspectType@path" if the aspect is attached to an entry's path. + "a_key": { # An aspect is a single piece of metadata describing an entry. + "aspectSource": { # AspectSource contains source system related information for the aspect. + "createTime": "A String", # The create time of the aspect in the source system. + "updateTime": "A String", # The update time of the aspect in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "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). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry was created. + "entrySource": { # EntrySource contains source system related information for the entry. # Optional. Source system related information for an entry. + "ancestors": [ # Immutable. The ancestors of the Entry in the source system. + { # Ancestor contains information about individual items in the hierarchy of an Entry. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The create time of the resource in the source system. + "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. + "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. + "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. + "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. + "updateTime": "A String", # The update time of the resource in the source system. + }, + "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "updateTime": "A String", # Output only. The time when the Entry was last updated. +}+++ +searchEntries(name, orderBy=None, pageSize=None, pageToken=None, query=None, scope=None, x__xgafv=None)+Searches for entries matching given query and scope. + +Args: + name: string, Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}. (required) + orderBy: string, Optional. Ordering of the results. Supported options to be added later. + pageSize: integer, Optional. Pagination. + pageToken: string, A parameter + query: string, Required. The query against which entries in scope should be matched. + scope: string, 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. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { + "nextPageToken": "A String", # Pagination token. + "results": [ # The results matching the search query. + { # A single result of a SearchEntries request. + "dataplexEntry": { # An entry is a representation of a data asset which can be described by various metadata. # Entry format of the result. + "aspects": { # Optional. The Aspects attached to the Entry. The key is either the resource name of the aspect type (if the aspect is attached directly to the entry) or "aspectType@path" if the aspect is attached to an entry's path. + "a_key": { # An aspect is a single piece of metadata describing an entry. + "aspectSource": { # AspectSource contains source system related information for the aspect. + "createTime": "A String", # The create time of the aspect in the source system. + "updateTime": "A String", # The update time of the aspect in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "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). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry was created. + "entrySource": { # EntrySource contains source system related information for the entry. # Optional. Source system related information for an entry. + "ancestors": [ # Immutable. The ancestors of the Entry in the source system. + { # Ancestor contains information about individual items in the hierarchy of an Entry. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The create time of the resource in the source system. + "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. + "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. + "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. + "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. + "updateTime": "A String", # The update time of the resource in the source system. + }, + "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "updateTime": "A String", # Output only. The time when the Entry was last updated. + }, + "description": "A String", # Entry description. + "displayName": "A String", # Display name. + "entry": "A String", # Resource name of the entry. + "entryType": "A String", # The entry type. + "fullyQualifiedName": "A String", # Fully qualified name. + "linkedResource": "A String", # Linked resource name. + "modifyTime": "A String", # The last modification timestamp. + "relativeResource": "A String", # Relative resource name. + "snippets": { # Snippets for the entry, contains HTML-style highlighting for matched tokens, will be used in UI. # Snippets. + "dataplexEntry": { # An entry is a representation of a data asset which can be described by various metadata. # Entry + "aspects": { # Optional. The Aspects attached to the Entry. The key is either the resource name of the aspect type (if the aspect is attached directly to the entry) or "aspectType@path" if the aspect is attached to an entry's path. + "a_key": { # An aspect is a single piece of metadata describing an entry. + "aspectSource": { # AspectSource contains source system related information for the aspect. + "createTime": "A String", # The create time of the aspect in the source system. + "updateTime": "A String", # The update time of the aspect in the source system. + }, + "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. + "createTime": "A String", # Output only. The time when the Aspect was created. + "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). + "a_key": "", # Properties of the object. + }, + "path": "A String", # Output only. The path in the entry under which the aspect is attached. + "updateTime": "A String", # Output only. The time when the Aspect was last updated. + }, + }, + "createTime": "A String", # Output only. The time when the Entry was created. + "entrySource": { # EntrySource contains source system related information for the entry. # Optional. Source system related information for an entry. + "ancestors": [ # Immutable. The ancestors of the Entry in the source system. + { # Ancestor contains information about individual items in the hierarchy of an Entry. + "name": "A String", # Optional. The name of the ancestor resource. + "type": "A String", # Optional. The type of the ancestor resource. + }, + ], + "createTime": "A String", # The create time of the resource in the source system. + "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. + "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. + "a_key": "A String", + }, + "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. + "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. + "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. + "updateTime": "A String", # The update time of the resource in the source system. + }, + "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. + "updateTime": "A String", # Output only. The time when the Entry was last updated. + }, + }, + }, + ], + "totalSize": 42, # The estimated total number of matching entries. Not guaranteed to be accurate. + "unreachable": [ # Unreachable locations. Search results don't include data from those locations. + "A String", + ], +}+++searchEntries_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++