Documentation
¶
Overview ¶
Package dataplex is an auto-generated package for the Cloud Dataplex API.
Dataplex API is used to manage the lifecycle of data lakes.
General documentation ¶
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage ¶
To get started with this package, create a client.
ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client ¶
The following is an example of making an API call with the newly created client.
ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CancelJobRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CancelJobRequest. } err = c.CancelJob(ctx, req) if err != nil { // TODO: Handle error. }
Use of Context ¶
The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Index ¶
- func DefaultAuthScopes() []string
- type ActionIterator
- type AspectTypeIterator
- type AssetIterator
- type CallOptions
- type CatalogCallOptions
- type CatalogClient
- func (c *CatalogClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *CatalogClient) Close() error
- func (c *CatalogClient) Connection() *grpc.ClientConndeprecated
- func (c *CatalogClient) CreateAspectType(ctx context.Context, req *dataplexpb.CreateAspectTypeRequest, ...) (*CreateAspectTypeOperation, error)
- func (c *CatalogClient) CreateAspectTypeOperation(name string) *CreateAspectTypeOperation
- func (c *CatalogClient) CreateEntry(ctx context.Context, req *dataplexpb.CreateEntryRequest, ...) (*dataplexpb.Entry, error)
- func (c *CatalogClient) CreateEntryGroup(ctx context.Context, req *dataplexpb.CreateEntryGroupRequest, ...) (*CreateEntryGroupOperation, error)
- func (c *CatalogClient) CreateEntryGroupOperation(name string) *CreateEntryGroupOperation
- func (c *CatalogClient) CreateEntryType(ctx context.Context, req *dataplexpb.CreateEntryTypeRequest, ...) (*CreateEntryTypeOperation, error)
- func (c *CatalogClient) CreateEntryTypeOperation(name string) *CreateEntryTypeOperation
- func (c *CatalogClient) DeleteAspectType(ctx context.Context, req *dataplexpb.DeleteAspectTypeRequest, ...) (*DeleteAspectTypeOperation, error)
- func (c *CatalogClient) DeleteAspectTypeOperation(name string) *DeleteAspectTypeOperation
- func (c *CatalogClient) DeleteEntry(ctx context.Context, req *dataplexpb.DeleteEntryRequest, ...) (*dataplexpb.Entry, error)
- func (c *CatalogClient) DeleteEntryGroup(ctx context.Context, req *dataplexpb.DeleteEntryGroupRequest, ...) (*DeleteEntryGroupOperation, error)
- func (c *CatalogClient) DeleteEntryGroupOperation(name string) *DeleteEntryGroupOperation
- func (c *CatalogClient) DeleteEntryType(ctx context.Context, req *dataplexpb.DeleteEntryTypeRequest, ...) (*DeleteEntryTypeOperation, error)
- func (c *CatalogClient) DeleteEntryTypeOperation(name string) *DeleteEntryTypeOperation
- func (c *CatalogClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *CatalogClient) GetAspectType(ctx context.Context, req *dataplexpb.GetAspectTypeRequest, ...) (*dataplexpb.AspectType, error)
- func (c *CatalogClient) GetEntry(ctx context.Context, req *dataplexpb.GetEntryRequest, opts ...gax.CallOption) (*dataplexpb.Entry, error)
- func (c *CatalogClient) GetEntryGroup(ctx context.Context, req *dataplexpb.GetEntryGroupRequest, ...) (*dataplexpb.EntryGroup, error)
- func (c *CatalogClient) GetEntryType(ctx context.Context, req *dataplexpb.GetEntryTypeRequest, ...) (*dataplexpb.EntryType, error)
- func (c *CatalogClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, ...) (*locationpb.Location, error)
- func (c *CatalogClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *CatalogClient) ListAspectTypes(ctx context.Context, req *dataplexpb.ListAspectTypesRequest, ...) *AspectTypeIterator
- func (c *CatalogClient) ListEntries(ctx context.Context, req *dataplexpb.ListEntriesRequest, ...) *EntryIterator
- func (c *CatalogClient) ListEntryGroups(ctx context.Context, req *dataplexpb.ListEntryGroupsRequest, ...) *EntryGroupIterator
- func (c *CatalogClient) ListEntryTypes(ctx context.Context, req *dataplexpb.ListEntryTypesRequest, ...) *EntryTypeIterator
- func (c *CatalogClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, ...) *LocationIterator
- func (c *CatalogClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *CatalogClient) LookupEntry(ctx context.Context, req *dataplexpb.LookupEntryRequest, ...) (*dataplexpb.Entry, error)
- func (c *CatalogClient) SearchEntries(ctx context.Context, req *dataplexpb.SearchEntriesRequest, ...) *SearchEntriesResultIterator
- func (c *CatalogClient) UpdateAspectType(ctx context.Context, req *dataplexpb.UpdateAspectTypeRequest, ...) (*UpdateAspectTypeOperation, error)
- func (c *CatalogClient) UpdateAspectTypeOperation(name string) *UpdateAspectTypeOperation
- func (c *CatalogClient) UpdateEntry(ctx context.Context, req *dataplexpb.UpdateEntryRequest, ...) (*dataplexpb.Entry, error)
- func (c *CatalogClient) UpdateEntryGroup(ctx context.Context, req *dataplexpb.UpdateEntryGroupRequest, ...) (*UpdateEntryGroupOperation, error)
- func (c *CatalogClient) UpdateEntryGroupOperation(name string) *UpdateEntryGroupOperation
- func (c *CatalogClient) UpdateEntryType(ctx context.Context, req *dataplexpb.UpdateEntryTypeRequest, ...) (*UpdateEntryTypeOperation, error)
- func (c *CatalogClient) UpdateEntryTypeOperation(name string) *UpdateEntryTypeOperation
- type Client
- func (c *Client) CancelJob(ctx context.Context, req *dataplexpb.CancelJobRequest, opts ...gax.CallOption) error
- func (c *Client) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *Client) Close() error
- func (c *Client) Connection() *grpc.ClientConndeprecated
- func (c *Client) CreateAsset(ctx context.Context, req *dataplexpb.CreateAssetRequest, ...) (*CreateAssetOperation, error)
- func (c *Client) CreateAssetOperation(name string) *CreateAssetOperation
- func (c *Client) CreateEnvironment(ctx context.Context, req *dataplexpb.CreateEnvironmentRequest, ...) (*CreateEnvironmentOperation, error)
- func (c *Client) CreateEnvironmentOperation(name string) *CreateEnvironmentOperation
- func (c *Client) CreateLake(ctx context.Context, req *dataplexpb.CreateLakeRequest, opts ...gax.CallOption) (*CreateLakeOperation, error)
- func (c *Client) CreateLakeOperation(name string) *CreateLakeOperation
- func (c *Client) CreateTask(ctx context.Context, req *dataplexpb.CreateTaskRequest, opts ...gax.CallOption) (*CreateTaskOperation, error)
- func (c *Client) CreateTaskOperation(name string) *CreateTaskOperation
- func (c *Client) CreateZone(ctx context.Context, req *dataplexpb.CreateZoneRequest, opts ...gax.CallOption) (*CreateZoneOperation, error)
- func (c *Client) CreateZoneOperation(name string) *CreateZoneOperation
- func (c *Client) DeleteAsset(ctx context.Context, req *dataplexpb.DeleteAssetRequest, ...) (*DeleteAssetOperation, error)
- func (c *Client) DeleteAssetOperation(name string) *DeleteAssetOperation
- func (c *Client) DeleteEnvironment(ctx context.Context, req *dataplexpb.DeleteEnvironmentRequest, ...) (*DeleteEnvironmentOperation, error)
- func (c *Client) DeleteEnvironmentOperation(name string) *DeleteEnvironmentOperation
- func (c *Client) DeleteLake(ctx context.Context, req *dataplexpb.DeleteLakeRequest, opts ...gax.CallOption) (*DeleteLakeOperation, error)
- func (c *Client) DeleteLakeOperation(name string) *DeleteLakeOperation
- func (c *Client) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *Client) DeleteTask(ctx context.Context, req *dataplexpb.DeleteTaskRequest, opts ...gax.CallOption) (*DeleteTaskOperation, error)
- func (c *Client) DeleteTaskOperation(name string) *DeleteTaskOperation
- func (c *Client) DeleteZone(ctx context.Context, req *dataplexpb.DeleteZoneRequest, opts ...gax.CallOption) (*DeleteZoneOperation, error)
- func (c *Client) DeleteZoneOperation(name string) *DeleteZoneOperation
- func (c *Client) GetAsset(ctx context.Context, req *dataplexpb.GetAssetRequest, opts ...gax.CallOption) (*dataplexpb.Asset, error)
- func (c *Client) GetEnvironment(ctx context.Context, req *dataplexpb.GetEnvironmentRequest, ...) (*dataplexpb.Environment, error)
- func (c *Client) GetJob(ctx context.Context, req *dataplexpb.GetJobRequest, opts ...gax.CallOption) (*dataplexpb.Job, error)
- func (c *Client) GetLake(ctx context.Context, req *dataplexpb.GetLakeRequest, opts ...gax.CallOption) (*dataplexpb.Lake, error)
- func (c *Client) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, ...) (*locationpb.Location, error)
- func (c *Client) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *Client) GetTask(ctx context.Context, req *dataplexpb.GetTaskRequest, opts ...gax.CallOption) (*dataplexpb.Task, error)
- func (c *Client) GetZone(ctx context.Context, req *dataplexpb.GetZoneRequest, opts ...gax.CallOption) (*dataplexpb.Zone, error)
- func (c *Client) ListAssetActions(ctx context.Context, req *dataplexpb.ListAssetActionsRequest, ...) *ActionIterator
- func (c *Client) ListAssets(ctx context.Context, req *dataplexpb.ListAssetsRequest, opts ...gax.CallOption) *AssetIterator
- func (c *Client) ListEnvironments(ctx context.Context, req *dataplexpb.ListEnvironmentsRequest, ...) *EnvironmentIterator
- func (c *Client) ListJobs(ctx context.Context, req *dataplexpb.ListJobsRequest, opts ...gax.CallOption) *JobIterator
- func (c *Client) ListLakeActions(ctx context.Context, req *dataplexpb.ListLakeActionsRequest, ...) *ActionIterator
- func (c *Client) ListLakes(ctx context.Context, req *dataplexpb.ListLakesRequest, opts ...gax.CallOption) *LakeIterator
- func (c *Client) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, ...) *LocationIterator
- func (c *Client) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *Client) ListSessions(ctx context.Context, req *dataplexpb.ListSessionsRequest, ...) *SessionIterator
- func (c *Client) ListTasks(ctx context.Context, req *dataplexpb.ListTasksRequest, opts ...gax.CallOption) *TaskIterator
- func (c *Client) ListZoneActions(ctx context.Context, req *dataplexpb.ListZoneActionsRequest, ...) *ActionIterator
- func (c *Client) ListZones(ctx context.Context, req *dataplexpb.ListZonesRequest, opts ...gax.CallOption) *ZoneIterator
- func (c *Client) RunTask(ctx context.Context, req *dataplexpb.RunTaskRequest, opts ...gax.CallOption) (*dataplexpb.RunTaskResponse, error)
- func (c *Client) UpdateAsset(ctx context.Context, req *dataplexpb.UpdateAssetRequest, ...) (*UpdateAssetOperation, error)
- func (c *Client) UpdateAssetOperation(name string) *UpdateAssetOperation
- func (c *Client) UpdateEnvironment(ctx context.Context, req *dataplexpb.UpdateEnvironmentRequest, ...) (*UpdateEnvironmentOperation, error)
- func (c *Client) UpdateEnvironmentOperation(name string) *UpdateEnvironmentOperation
- func (c *Client) UpdateLake(ctx context.Context, req *dataplexpb.UpdateLakeRequest, opts ...gax.CallOption) (*UpdateLakeOperation, error)
- func (c *Client) UpdateLakeOperation(name string) *UpdateLakeOperation
- func (c *Client) UpdateTask(ctx context.Context, req *dataplexpb.UpdateTaskRequest, opts ...gax.CallOption) (*UpdateTaskOperation, error)
- func (c *Client) UpdateTaskOperation(name string) *UpdateTaskOperation
- func (c *Client) UpdateZone(ctx context.Context, req *dataplexpb.UpdateZoneRequest, opts ...gax.CallOption) (*UpdateZoneOperation, error)
- func (c *Client) UpdateZoneOperation(name string) *UpdateZoneOperation
- type ContentCallOptions
- type ContentClient
- func (c *ContentClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *ContentClient) Close() error
- func (c *ContentClient) Connection() *grpc.ClientConndeprecated
- func (c *ContentClient) CreateContent(ctx context.Context, req *dataplexpb.CreateContentRequest, ...) (*dataplexpb.Content, error)
- func (c *ContentClient) DeleteContent(ctx context.Context, req *dataplexpb.DeleteContentRequest, ...) error
- func (c *ContentClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *ContentClient) GetContent(ctx context.Context, req *dataplexpb.GetContentRequest, opts ...gax.CallOption) (*dataplexpb.Content, error)
- func (c *ContentClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *ContentClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, ...) (*locationpb.Location, error)
- func (c *ContentClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *ContentClient) ListContent(ctx context.Context, req *dataplexpb.ListContentRequest, ...) *ContentIterator
- func (c *ContentClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, ...) *LocationIterator
- func (c *ContentClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *ContentClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *ContentClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, ...) (*iampb.TestIamPermissionsResponse, error)
- func (c *ContentClient) UpdateContent(ctx context.Context, req *dataplexpb.UpdateContentRequest, ...) (*dataplexpb.Content, error)
- type ContentIterator
- type CreateAspectTypeOperation
- func (op *CreateAspectTypeOperation) Done() bool
- func (op *CreateAspectTypeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *CreateAspectTypeOperation) Name() string
- func (op *CreateAspectTypeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.AspectType, error)
- func (op *CreateAspectTypeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.AspectType, error)
- type CreateAssetOperation
- func (op *CreateAssetOperation) Done() bool
- func (op *CreateAssetOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *CreateAssetOperation) Name() string
- func (op *CreateAssetOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Asset, error)
- func (op *CreateAssetOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Asset, error)
- type CreateDataAttributeBindingOperation
- func (op *CreateDataAttributeBindingOperation) Done() bool
- func (op *CreateDataAttributeBindingOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *CreateDataAttributeBindingOperation) Name() string
- func (op *CreateDataAttributeBindingOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttributeBinding, error)
- func (op *CreateDataAttributeBindingOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttributeBinding, error)
- type CreateDataAttributeOperation
- func (op *CreateDataAttributeOperation) Done() bool
- func (op *CreateDataAttributeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *CreateDataAttributeOperation) Name() string
- func (op *CreateDataAttributeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttribute, error)
- func (op *CreateDataAttributeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttribute, error)
- type CreateDataScanOperation
- func (op *CreateDataScanOperation) Done() bool
- func (op *CreateDataScanOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *CreateDataScanOperation) Name() string
- func (op *CreateDataScanOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataScan, error)
- func (op *CreateDataScanOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataScan, error)
- type CreateDataTaxonomyOperation
- func (op *CreateDataTaxonomyOperation) Done() bool
- func (op *CreateDataTaxonomyOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *CreateDataTaxonomyOperation) Name() string
- func (op *CreateDataTaxonomyOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataTaxonomy, error)
- func (op *CreateDataTaxonomyOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataTaxonomy, error)
- type CreateEntryGroupOperation
- func (op *CreateEntryGroupOperation) Done() bool
- func (op *CreateEntryGroupOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *CreateEntryGroupOperation) Name() string
- func (op *CreateEntryGroupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryGroup, error)
- func (op *CreateEntryGroupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryGroup, error)
- type CreateEntryTypeOperation
- func (op *CreateEntryTypeOperation) Done() bool
- func (op *CreateEntryTypeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *CreateEntryTypeOperation) Name() string
- func (op *CreateEntryTypeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryType, error)
- func (op *CreateEntryTypeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryType, error)
- type CreateEnvironmentOperation
- func (op *CreateEnvironmentOperation) Done() bool
- func (op *CreateEnvironmentOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *CreateEnvironmentOperation) Name() string
- func (op *CreateEnvironmentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Environment, error)
- func (op *CreateEnvironmentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Environment, error)
- type CreateLakeOperation
- func (op *CreateLakeOperation) Done() bool
- func (op *CreateLakeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *CreateLakeOperation) Name() string
- func (op *CreateLakeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Lake, error)
- func (op *CreateLakeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Lake, error)
- type CreateTaskOperation
- func (op *CreateTaskOperation) Done() bool
- func (op *CreateTaskOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *CreateTaskOperation) Name() string
- func (op *CreateTaskOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Task, error)
- func (op *CreateTaskOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Task, error)
- type CreateZoneOperation
- func (op *CreateZoneOperation) Done() bool
- func (op *CreateZoneOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *CreateZoneOperation) Name() string
- func (op *CreateZoneOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Zone, error)
- func (op *CreateZoneOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Zone, error)
- type DataAttributeBindingIterator
- type DataAttributeIterator
- type DataScanCallOptions
- type DataScanClient
- func (c *DataScanClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *DataScanClient) Close() error
- func (c *DataScanClient) Connection() *grpc.ClientConndeprecated
- func (c *DataScanClient) CreateDataScan(ctx context.Context, req *dataplexpb.CreateDataScanRequest, ...) (*CreateDataScanOperation, error)
- func (c *DataScanClient) CreateDataScanOperation(name string) *CreateDataScanOperation
- func (c *DataScanClient) DeleteDataScan(ctx context.Context, req *dataplexpb.DeleteDataScanRequest, ...) (*DeleteDataScanOperation, error)
- func (c *DataScanClient) DeleteDataScanOperation(name string) *DeleteDataScanOperation
- func (c *DataScanClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *DataScanClient) GenerateDataQualityRules(ctx context.Context, req *dataplexpb.GenerateDataQualityRulesRequest, ...) (*dataplexpb.GenerateDataQualityRulesResponse, error)
- func (c *DataScanClient) GetDataScan(ctx context.Context, req *dataplexpb.GetDataScanRequest, ...) (*dataplexpb.DataScan, error)
- func (c *DataScanClient) GetDataScanJob(ctx context.Context, req *dataplexpb.GetDataScanJobRequest, ...) (*dataplexpb.DataScanJob, error)
- func (c *DataScanClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, ...) (*locationpb.Location, error)
- func (c *DataScanClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *DataScanClient) ListDataScanJobs(ctx context.Context, req *dataplexpb.ListDataScanJobsRequest, ...) *DataScanJobIterator
- func (c *DataScanClient) ListDataScans(ctx context.Context, req *dataplexpb.ListDataScansRequest, ...) *DataScanIterator
- func (c *DataScanClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, ...) *LocationIterator
- func (c *DataScanClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *DataScanClient) RunDataScan(ctx context.Context, req *dataplexpb.RunDataScanRequest, ...) (*dataplexpb.RunDataScanResponse, error)
- func (c *DataScanClient) UpdateDataScan(ctx context.Context, req *dataplexpb.UpdateDataScanRequest, ...) (*UpdateDataScanOperation, error)
- func (c *DataScanClient) UpdateDataScanOperation(name string) *UpdateDataScanOperation
- type DataScanIterator
- type DataScanJobIterator
- type DataTaxonomyCallOptions
- type DataTaxonomyClient
- func (c *DataTaxonomyClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *DataTaxonomyClient) Close() error
- func (c *DataTaxonomyClient) Connection() *grpc.ClientConndeprecated
- func (c *DataTaxonomyClient) CreateDataAttribute(ctx context.Context, req *dataplexpb.CreateDataAttributeRequest, ...) (*CreateDataAttributeOperation, error)
- func (c *DataTaxonomyClient) CreateDataAttributeBinding(ctx context.Context, req *dataplexpb.CreateDataAttributeBindingRequest, ...) (*CreateDataAttributeBindingOperation, error)
- func (c *DataTaxonomyClient) CreateDataAttributeBindingOperation(name string) *CreateDataAttributeBindingOperation
- func (c *DataTaxonomyClient) CreateDataAttributeOperation(name string) *CreateDataAttributeOperation
- func (c *DataTaxonomyClient) CreateDataTaxonomy(ctx context.Context, req *dataplexpb.CreateDataTaxonomyRequest, ...) (*CreateDataTaxonomyOperation, error)
- func (c *DataTaxonomyClient) CreateDataTaxonomyOperation(name string) *CreateDataTaxonomyOperation
- func (c *DataTaxonomyClient) DeleteDataAttribute(ctx context.Context, req *dataplexpb.DeleteDataAttributeRequest, ...) (*DeleteDataAttributeOperation, error)
- func (c *DataTaxonomyClient) DeleteDataAttributeBinding(ctx context.Context, req *dataplexpb.DeleteDataAttributeBindingRequest, ...) (*DeleteDataAttributeBindingOperation, error)
- func (c *DataTaxonomyClient) DeleteDataAttributeBindingOperation(name string) *DeleteDataAttributeBindingOperation
- func (c *DataTaxonomyClient) DeleteDataAttributeOperation(name string) *DeleteDataAttributeOperation
- func (c *DataTaxonomyClient) DeleteDataTaxonomy(ctx context.Context, req *dataplexpb.DeleteDataTaxonomyRequest, ...) (*DeleteDataTaxonomyOperation, error)
- func (c *DataTaxonomyClient) DeleteDataTaxonomyOperation(name string) *DeleteDataTaxonomyOperation
- func (c *DataTaxonomyClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *DataTaxonomyClient) GetDataAttribute(ctx context.Context, req *dataplexpb.GetDataAttributeRequest, ...) (*dataplexpb.DataAttribute, error)
- func (c *DataTaxonomyClient) GetDataAttributeBinding(ctx context.Context, req *dataplexpb.GetDataAttributeBindingRequest, ...) (*dataplexpb.DataAttributeBinding, error)
- func (c *DataTaxonomyClient) GetDataTaxonomy(ctx context.Context, req *dataplexpb.GetDataTaxonomyRequest, ...) (*dataplexpb.DataTaxonomy, error)
- func (c *DataTaxonomyClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, ...) (*locationpb.Location, error)
- func (c *DataTaxonomyClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *DataTaxonomyClient) ListDataAttributeBindings(ctx context.Context, req *dataplexpb.ListDataAttributeBindingsRequest, ...) *DataAttributeBindingIterator
- func (c *DataTaxonomyClient) ListDataAttributes(ctx context.Context, req *dataplexpb.ListDataAttributesRequest, ...) *DataAttributeIterator
- func (c *DataTaxonomyClient) ListDataTaxonomies(ctx context.Context, req *dataplexpb.ListDataTaxonomiesRequest, ...) *DataTaxonomyIterator
- func (c *DataTaxonomyClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, ...) *LocationIterator
- func (c *DataTaxonomyClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *DataTaxonomyClient) UpdateDataAttribute(ctx context.Context, req *dataplexpb.UpdateDataAttributeRequest, ...) (*UpdateDataAttributeOperation, error)
- func (c *DataTaxonomyClient) UpdateDataAttributeBinding(ctx context.Context, req *dataplexpb.UpdateDataAttributeBindingRequest, ...) (*UpdateDataAttributeBindingOperation, error)
- func (c *DataTaxonomyClient) UpdateDataAttributeBindingOperation(name string) *UpdateDataAttributeBindingOperation
- func (c *DataTaxonomyClient) UpdateDataAttributeOperation(name string) *UpdateDataAttributeOperation
- func (c *DataTaxonomyClient) UpdateDataTaxonomy(ctx context.Context, req *dataplexpb.UpdateDataTaxonomyRequest, ...) (*UpdateDataTaxonomyOperation, error)
- func (c *DataTaxonomyClient) UpdateDataTaxonomyOperation(name string) *UpdateDataTaxonomyOperation
- type DataTaxonomyIterator
- type DeleteAspectTypeOperation
- func (op *DeleteAspectTypeOperation) Done() bool
- func (op *DeleteAspectTypeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *DeleteAspectTypeOperation) Name() string
- func (op *DeleteAspectTypeOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteAspectTypeOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteAssetOperation
- func (op *DeleteAssetOperation) Done() bool
- func (op *DeleteAssetOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *DeleteAssetOperation) Name() string
- func (op *DeleteAssetOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteAssetOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteDataAttributeBindingOperation
- func (op *DeleteDataAttributeBindingOperation) Done() bool
- func (op *DeleteDataAttributeBindingOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *DeleteDataAttributeBindingOperation) Name() string
- func (op *DeleteDataAttributeBindingOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteDataAttributeBindingOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteDataAttributeOperation
- func (op *DeleteDataAttributeOperation) Done() bool
- func (op *DeleteDataAttributeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *DeleteDataAttributeOperation) Name() string
- func (op *DeleteDataAttributeOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteDataAttributeOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteDataScanOperation
- func (op *DeleteDataScanOperation) Done() bool
- func (op *DeleteDataScanOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *DeleteDataScanOperation) Name() string
- func (op *DeleteDataScanOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteDataScanOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteDataTaxonomyOperation
- func (op *DeleteDataTaxonomyOperation) Done() bool
- func (op *DeleteDataTaxonomyOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *DeleteDataTaxonomyOperation) Name() string
- func (op *DeleteDataTaxonomyOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteDataTaxonomyOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteEntryGroupOperation
- func (op *DeleteEntryGroupOperation) Done() bool
- func (op *DeleteEntryGroupOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *DeleteEntryGroupOperation) Name() string
- func (op *DeleteEntryGroupOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteEntryGroupOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteEntryTypeOperation
- func (op *DeleteEntryTypeOperation) Done() bool
- func (op *DeleteEntryTypeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *DeleteEntryTypeOperation) Name() string
- func (op *DeleteEntryTypeOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteEntryTypeOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteEnvironmentOperation
- func (op *DeleteEnvironmentOperation) Done() bool
- func (op *DeleteEnvironmentOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *DeleteEnvironmentOperation) Name() string
- func (op *DeleteEnvironmentOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteEnvironmentOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteLakeOperation
- func (op *DeleteLakeOperation) Done() bool
- func (op *DeleteLakeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *DeleteLakeOperation) Name() string
- func (op *DeleteLakeOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteLakeOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteTaskOperation
- func (op *DeleteTaskOperation) Done() bool
- func (op *DeleteTaskOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *DeleteTaskOperation) Name() string
- func (op *DeleteTaskOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteTaskOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteZoneOperation
- func (op *DeleteZoneOperation) Done() bool
- func (op *DeleteZoneOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *DeleteZoneOperation) Name() string
- func (op *DeleteZoneOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteZoneOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type EntityIterator
- type EntryGroupIterator
- type EntryIterator
- type EntryTypeIterator
- type EnvironmentIterator
- type JobIterator
- type LakeIterator
- type LocationIterator
- type MetadataCallOptions
- type MetadataClient
- func (c *MetadataClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *MetadataClient) Close() error
- func (c *MetadataClient) Connection() *grpc.ClientConndeprecated
- func (c *MetadataClient) CreateEntity(ctx context.Context, req *dataplexpb.CreateEntityRequest, ...) (*dataplexpb.Entity, error)
- func (c *MetadataClient) CreatePartition(ctx context.Context, req *dataplexpb.CreatePartitionRequest, ...) (*dataplexpb.Partition, error)
- func (c *MetadataClient) DeleteEntity(ctx context.Context, req *dataplexpb.DeleteEntityRequest, ...) error
- func (c *MetadataClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *MetadataClient) DeletePartition(ctx context.Context, req *dataplexpb.DeletePartitionRequest, ...) error
- func (c *MetadataClient) GetEntity(ctx context.Context, req *dataplexpb.GetEntityRequest, opts ...gax.CallOption) (*dataplexpb.Entity, error)
- func (c *MetadataClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, ...) (*locationpb.Location, error)
- func (c *MetadataClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *MetadataClient) GetPartition(ctx context.Context, req *dataplexpb.GetPartitionRequest, ...) (*dataplexpb.Partition, error)
- func (c *MetadataClient) ListEntities(ctx context.Context, req *dataplexpb.ListEntitiesRequest, ...) *EntityIterator
- func (c *MetadataClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, ...) *LocationIterator
- func (c *MetadataClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *MetadataClient) ListPartitions(ctx context.Context, req *dataplexpb.ListPartitionsRequest, ...) *PartitionIterator
- func (c *MetadataClient) UpdateEntity(ctx context.Context, req *dataplexpb.UpdateEntityRequest, ...) (*dataplexpb.Entity, error)
- type OperationIterator
- type PartitionIterator
- type SearchEntriesResultIterator
- type SessionIterator
- type TaskIterator
- type UpdateAspectTypeOperation
- func (op *UpdateAspectTypeOperation) Done() bool
- func (op *UpdateAspectTypeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *UpdateAspectTypeOperation) Name() string
- func (op *UpdateAspectTypeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.AspectType, error)
- func (op *UpdateAspectTypeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.AspectType, error)
- type UpdateAssetOperation
- func (op *UpdateAssetOperation) Done() bool
- func (op *UpdateAssetOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *UpdateAssetOperation) Name() string
- func (op *UpdateAssetOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Asset, error)
- func (op *UpdateAssetOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Asset, error)
- type UpdateDataAttributeBindingOperation
- func (op *UpdateDataAttributeBindingOperation) Done() bool
- func (op *UpdateDataAttributeBindingOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *UpdateDataAttributeBindingOperation) Name() string
- func (op *UpdateDataAttributeBindingOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttributeBinding, error)
- func (op *UpdateDataAttributeBindingOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttributeBinding, error)
- type UpdateDataAttributeOperation
- func (op *UpdateDataAttributeOperation) Done() bool
- func (op *UpdateDataAttributeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *UpdateDataAttributeOperation) Name() string
- func (op *UpdateDataAttributeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttribute, error)
- func (op *UpdateDataAttributeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttribute, error)
- type UpdateDataScanOperation
- func (op *UpdateDataScanOperation) Done() bool
- func (op *UpdateDataScanOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *UpdateDataScanOperation) Name() string
- func (op *UpdateDataScanOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataScan, error)
- func (op *UpdateDataScanOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataScan, error)
- type UpdateDataTaxonomyOperation
- func (op *UpdateDataTaxonomyOperation) Done() bool
- func (op *UpdateDataTaxonomyOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *UpdateDataTaxonomyOperation) Name() string
- func (op *UpdateDataTaxonomyOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataTaxonomy, error)
- func (op *UpdateDataTaxonomyOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataTaxonomy, error)
- type UpdateEntryGroupOperation
- func (op *UpdateEntryGroupOperation) Done() bool
- func (op *UpdateEntryGroupOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *UpdateEntryGroupOperation) Name() string
- func (op *UpdateEntryGroupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryGroup, error)
- func (op *UpdateEntryGroupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryGroup, error)
- type UpdateEntryTypeOperation
- func (op *UpdateEntryTypeOperation) Done() bool
- func (op *UpdateEntryTypeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *UpdateEntryTypeOperation) Name() string
- func (op *UpdateEntryTypeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryType, error)
- func (op *UpdateEntryTypeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryType, error)
- type UpdateEnvironmentOperation
- func (op *UpdateEnvironmentOperation) Done() bool
- func (op *UpdateEnvironmentOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *UpdateEnvironmentOperation) Name() string
- func (op *UpdateEnvironmentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Environment, error)
- func (op *UpdateEnvironmentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Environment, error)
- type UpdateLakeOperation
- func (op *UpdateLakeOperation) Done() bool
- func (op *UpdateLakeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *UpdateLakeOperation) Name() string
- func (op *UpdateLakeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Lake, error)
- func (op *UpdateLakeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Lake, error)
- type UpdateTaskOperation
- func (op *UpdateTaskOperation) Done() bool
- func (op *UpdateTaskOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *UpdateTaskOperation) Name() string
- func (op *UpdateTaskOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Task, error)
- func (op *UpdateTaskOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Task, error)
- type UpdateZoneOperation
- func (op *UpdateZoneOperation) Done() bool
- func (op *UpdateZoneOperation) Metadata() (*dataplexpb.OperationMetadata, error)
- func (op *UpdateZoneOperation) Name() string
- func (op *UpdateZoneOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Zone, error)
- func (op *UpdateZoneOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Zone, error)
- type ZoneIterator
Examples ¶
- CatalogClient.CancelOperation
- CatalogClient.CreateAspectType
- CatalogClient.CreateEntry
- CatalogClient.CreateEntryGroup
- CatalogClient.CreateEntryType
- CatalogClient.DeleteAspectType
- CatalogClient.DeleteEntry
- CatalogClient.DeleteEntryGroup
- CatalogClient.DeleteEntryType
- CatalogClient.DeleteOperation
- CatalogClient.GetAspectType
- CatalogClient.GetEntry
- CatalogClient.GetEntryGroup
- CatalogClient.GetEntryType
- CatalogClient.GetLocation
- CatalogClient.GetOperation
- CatalogClient.ListAspectTypes
- CatalogClient.ListEntries
- CatalogClient.ListEntryGroups
- CatalogClient.ListEntryTypes
- CatalogClient.ListLocations
- CatalogClient.ListOperations
- CatalogClient.LookupEntry
- CatalogClient.SearchEntries
- CatalogClient.UpdateAspectType
- CatalogClient.UpdateEntry
- CatalogClient.UpdateEntryGroup
- CatalogClient.UpdateEntryType
- Client.CancelJob
- Client.CancelOperation
- Client.CreateAsset
- Client.CreateEnvironment
- Client.CreateLake
- Client.CreateTask
- Client.CreateZone
- Client.DeleteAsset
- Client.DeleteEnvironment
- Client.DeleteLake
- Client.DeleteOperation
- Client.DeleteTask
- Client.DeleteZone
- Client.GetAsset
- Client.GetEnvironment
- Client.GetJob
- Client.GetLake
- Client.GetLocation
- Client.GetOperation
- Client.GetTask
- Client.GetZone
- Client.ListAssetActions
- Client.ListAssets
- Client.ListEnvironments
- Client.ListJobs
- Client.ListLakeActions
- Client.ListLakes
- Client.ListLocations
- Client.ListOperations
- Client.ListSessions
- Client.ListTasks
- Client.ListZoneActions
- Client.ListZones
- Client.RunTask
- Client.UpdateAsset
- Client.UpdateEnvironment
- Client.UpdateLake
- Client.UpdateTask
- Client.UpdateZone
- ContentClient.CancelOperation
- ContentClient.CreateContent
- ContentClient.DeleteContent
- ContentClient.DeleteOperation
- ContentClient.GetContent
- ContentClient.GetIamPolicy
- ContentClient.GetLocation
- ContentClient.GetOperation
- ContentClient.ListContent
- ContentClient.ListLocations
- ContentClient.ListOperations
- ContentClient.SetIamPolicy
- ContentClient.TestIamPermissions
- ContentClient.UpdateContent
- DataScanClient.CancelOperation
- DataScanClient.CreateDataScan
- DataScanClient.DeleteDataScan
- DataScanClient.DeleteOperation
- DataScanClient.GenerateDataQualityRules
- DataScanClient.GetDataScan
- DataScanClient.GetDataScanJob
- DataScanClient.GetLocation
- DataScanClient.GetOperation
- DataScanClient.ListDataScanJobs
- DataScanClient.ListDataScans
- DataScanClient.ListLocations
- DataScanClient.ListOperations
- DataScanClient.RunDataScan
- DataScanClient.UpdateDataScan
- DataTaxonomyClient.CancelOperation
- DataTaxonomyClient.CreateDataAttribute
- DataTaxonomyClient.CreateDataAttributeBinding
- DataTaxonomyClient.CreateDataTaxonomy
- DataTaxonomyClient.DeleteDataAttribute
- DataTaxonomyClient.DeleteDataAttributeBinding
- DataTaxonomyClient.DeleteDataTaxonomy
- DataTaxonomyClient.DeleteOperation
- DataTaxonomyClient.GetDataAttribute
- DataTaxonomyClient.GetDataAttributeBinding
- DataTaxonomyClient.GetDataTaxonomy
- DataTaxonomyClient.GetLocation
- DataTaxonomyClient.GetOperation
- DataTaxonomyClient.ListDataAttributeBindings
- DataTaxonomyClient.ListDataAttributes
- DataTaxonomyClient.ListDataTaxonomies
- DataTaxonomyClient.ListLocations
- DataTaxonomyClient.ListOperations
- DataTaxonomyClient.UpdateDataAttribute
- DataTaxonomyClient.UpdateDataAttributeBinding
- DataTaxonomyClient.UpdateDataTaxonomy
- MetadataClient.CancelOperation
- MetadataClient.CreateEntity
- MetadataClient.CreatePartition
- MetadataClient.DeleteEntity
- MetadataClient.DeleteOperation
- MetadataClient.DeletePartition
- MetadataClient.GetEntity
- MetadataClient.GetLocation
- MetadataClient.GetOperation
- MetadataClient.GetPartition
- MetadataClient.ListEntities
- MetadataClient.ListLocations
- MetadataClient.ListOperations
- MetadataClient.ListPartitions
- MetadataClient.UpdateEntity
- NewCatalogClient
- NewClient
- NewContentClient
- NewDataScanClient
- NewDataTaxonomyClient
- NewMetadataClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultAuthScopes ¶
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
Types ¶
type ActionIterator ¶
type ActionIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.Action, nextPageToken string, err error) // contains filtered or unexported fields }
ActionIterator manages a stream of *dataplexpb.Action.
func (*ActionIterator) Next ¶
func (it *ActionIterator) Next() (*dataplexpb.Action, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ActionIterator) PageInfo ¶
func (it *ActionIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type AspectTypeIterator ¶ added in v1.15.0
type AspectTypeIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.AspectType, nextPageToken string, err error) // contains filtered or unexported fields }
AspectTypeIterator manages a stream of *dataplexpb.AspectType.
func (*AspectTypeIterator) Next ¶ added in v1.15.0
func (it *AspectTypeIterator) Next() (*dataplexpb.AspectType, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*AspectTypeIterator) PageInfo ¶ added in v1.15.0
func (it *AspectTypeIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type AssetIterator ¶
type AssetIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.Asset, nextPageToken string, err error) // contains filtered or unexported fields }
AssetIterator manages a stream of *dataplexpb.Asset.
func (*AssetIterator) Next ¶
func (it *AssetIterator) Next() (*dataplexpb.Asset, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*AssetIterator) PageInfo ¶
func (it *AssetIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type CallOptions ¶
type CallOptions struct { CreateLake []gax.CallOption UpdateLake []gax.CallOption DeleteLake []gax.CallOption ListLakes []gax.CallOption GetLake []gax.CallOption ListLakeActions []gax.CallOption CreateZone []gax.CallOption UpdateZone []gax.CallOption DeleteZone []gax.CallOption ListZones []gax.CallOption GetZone []gax.CallOption ListZoneActions []gax.CallOption CreateAsset []gax.CallOption UpdateAsset []gax.CallOption DeleteAsset []gax.CallOption ListAssets []gax.CallOption GetAsset []gax.CallOption ListAssetActions []gax.CallOption CreateTask []gax.CallOption UpdateTask []gax.CallOption DeleteTask []gax.CallOption ListTasks []gax.CallOption GetTask []gax.CallOption ListJobs []gax.CallOption RunTask []gax.CallOption GetJob []gax.CallOption CancelJob []gax.CallOption CreateEnvironment []gax.CallOption UpdateEnvironment []gax.CallOption DeleteEnvironment []gax.CallOption ListEnvironments []gax.CallOption GetEnvironment []gax.CallOption ListSessions []gax.CallOption GetLocation []gax.CallOption ListLocations []gax.CallOption CancelOperation []gax.CallOption DeleteOperation []gax.CallOption GetOperation []gax.CallOption ListOperations []gax.CallOption }
CallOptions contains the retry settings for each method of Client.
type CatalogCallOptions ¶ added in v1.15.0
type CatalogCallOptions struct { CreateEntryType []gax.CallOption UpdateEntryType []gax.CallOption DeleteEntryType []gax.CallOption ListEntryTypes []gax.CallOption GetEntryType []gax.CallOption CreateAspectType []gax.CallOption UpdateAspectType []gax.CallOption DeleteAspectType []gax.CallOption ListAspectTypes []gax.CallOption GetAspectType []gax.CallOption CreateEntryGroup []gax.CallOption UpdateEntryGroup []gax.CallOption DeleteEntryGroup []gax.CallOption ListEntryGroups []gax.CallOption GetEntryGroup []gax.CallOption CreateEntry []gax.CallOption UpdateEntry []gax.CallOption DeleteEntry []gax.CallOption ListEntries []gax.CallOption GetEntry []gax.CallOption LookupEntry []gax.CallOption SearchEntries []gax.CallOption GetLocation []gax.CallOption ListLocations []gax.CallOption CancelOperation []gax.CallOption DeleteOperation []gax.CallOption GetOperation []gax.CallOption ListOperations []gax.CallOption }
CatalogCallOptions contains the retry settings for each method of CatalogClient.
type CatalogClient ¶ added in v1.15.0
type CatalogClient struct { // The call options for this service. CallOptions *CatalogCallOptions // LROClient is used internally to handle long-running operations. // It is exposed so that its CallOptions can be modified if required. // Users should not Close this client. LROClient *lroauto.OperationsClient // contains filtered or unexported fields }
CatalogClient is a client for interacting with Cloud Dataplex API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The primary resources offered by this service are EntryGroups, EntryTypes, AspectTypes, Entry and Aspect which collectively allow a data administrator to organize, manage, secure and catalog data across their organization located across cloud projects in a variety of storage systems including Cloud Storage and BigQuery.
func NewCatalogClient ¶ added in v1.15.0
func NewCatalogClient(ctx context.Context, opts ...option.ClientOption) (*CatalogClient, error)
NewCatalogClient creates a new catalog service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The primary resources offered by this service are EntryGroups, EntryTypes, AspectTypes, Entry and Aspect which collectively allow a data administrator to organize, manage, secure and catalog data across their organization located across cloud projects in a variety of storage systems including Cloud Storage and BigQuery.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*CatalogClient) CancelOperation ¶ added in v1.15.0
func (c *CatalogClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*CatalogClient) Close ¶ added in v1.15.0
func (c *CatalogClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*CatalogClient) Connection
deprecated
added in
v1.15.0
func (c *CatalogClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*CatalogClient) CreateAspectType ¶ added in v1.15.0
func (c *CatalogClient) CreateAspectType(ctx context.Context, req *dataplexpb.CreateAspectTypeRequest, opts ...gax.CallOption) (*CreateAspectTypeOperation, error)
CreateAspectType creates an AspectType
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreateAspectTypeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateAspectTypeRequest. } op, err := c.CreateAspectType(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) CreateAspectTypeOperation ¶ added in v1.15.0
func (c *CatalogClient) CreateAspectTypeOperation(name string) *CreateAspectTypeOperation
CreateAspectTypeOperation returns a new CreateAspectTypeOperation from a given name. The name must be that of a previously created CreateAspectTypeOperation, possibly from a different process.
func (*CatalogClient) CreateEntry ¶ added in v1.15.0
func (c *CatalogClient) CreateEntry(ctx context.Context, req *dataplexpb.CreateEntryRequest, opts ...gax.CallOption) (*dataplexpb.Entry, error)
CreateEntry creates an Entry.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreateEntryRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateEntryRequest. } resp, err := c.CreateEntry(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) CreateEntryGroup ¶ added in v1.15.0
func (c *CatalogClient) CreateEntryGroup(ctx context.Context, req *dataplexpb.CreateEntryGroupRequest, opts ...gax.CallOption) (*CreateEntryGroupOperation, error)
CreateEntryGroup creates an EntryGroup
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreateEntryGroupRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateEntryGroupRequest. } op, err := c.CreateEntryGroup(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) CreateEntryGroupOperation ¶ added in v1.15.0
func (c *CatalogClient) CreateEntryGroupOperation(name string) *CreateEntryGroupOperation
CreateEntryGroupOperation returns a new CreateEntryGroupOperation from a given name. The name must be that of a previously created CreateEntryGroupOperation, possibly from a different process.
func (*CatalogClient) CreateEntryType ¶ added in v1.15.0
func (c *CatalogClient) CreateEntryType(ctx context.Context, req *dataplexpb.CreateEntryTypeRequest, opts ...gax.CallOption) (*CreateEntryTypeOperation, error)
CreateEntryType creates an EntryType
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreateEntryTypeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateEntryTypeRequest. } op, err := c.CreateEntryType(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) CreateEntryTypeOperation ¶ added in v1.15.0
func (c *CatalogClient) CreateEntryTypeOperation(name string) *CreateEntryTypeOperation
CreateEntryTypeOperation returns a new CreateEntryTypeOperation from a given name. The name must be that of a previously created CreateEntryTypeOperation, possibly from a different process.
func (*CatalogClient) DeleteAspectType ¶ added in v1.15.0
func (c *CatalogClient) DeleteAspectType(ctx context.Context, req *dataplexpb.DeleteAspectTypeRequest, opts ...gax.CallOption) (*DeleteAspectTypeOperation, error)
DeleteAspectType deletes a AspectType resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeleteAspectTypeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteAspectTypeRequest. } op, err := c.DeleteAspectType(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*CatalogClient) DeleteAspectTypeOperation ¶ added in v1.15.0
func (c *CatalogClient) DeleteAspectTypeOperation(name string) *DeleteAspectTypeOperation
DeleteAspectTypeOperation returns a new DeleteAspectTypeOperation from a given name. The name must be that of a previously created DeleteAspectTypeOperation, possibly from a different process.
func (*CatalogClient) DeleteEntry ¶ added in v1.15.0
func (c *CatalogClient) DeleteEntry(ctx context.Context, req *dataplexpb.DeleteEntryRequest, opts ...gax.CallOption) (*dataplexpb.Entry, error)
DeleteEntry deletes an Entry.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeleteEntryRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteEntryRequest. } resp, err := c.DeleteEntry(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) DeleteEntryGroup ¶ added in v1.15.0
func (c *CatalogClient) DeleteEntryGroup(ctx context.Context, req *dataplexpb.DeleteEntryGroupRequest, opts ...gax.CallOption) (*DeleteEntryGroupOperation, error)
DeleteEntryGroup deletes a EntryGroup resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeleteEntryGroupRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteEntryGroupRequest. } op, err := c.DeleteEntryGroup(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*CatalogClient) DeleteEntryGroupOperation ¶ added in v1.15.0
func (c *CatalogClient) DeleteEntryGroupOperation(name string) *DeleteEntryGroupOperation
DeleteEntryGroupOperation returns a new DeleteEntryGroupOperation from a given name. The name must be that of a previously created DeleteEntryGroupOperation, possibly from a different process.
func (*CatalogClient) DeleteEntryType ¶ added in v1.15.0
func (c *CatalogClient) DeleteEntryType(ctx context.Context, req *dataplexpb.DeleteEntryTypeRequest, opts ...gax.CallOption) (*DeleteEntryTypeOperation, error)
DeleteEntryType deletes a EntryType resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeleteEntryTypeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteEntryTypeRequest. } op, err := c.DeleteEntryType(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*CatalogClient) DeleteEntryTypeOperation ¶ added in v1.15.0
func (c *CatalogClient) DeleteEntryTypeOperation(name string) *DeleteEntryTypeOperation
DeleteEntryTypeOperation returns a new DeleteEntryTypeOperation from a given name. The name must be that of a previously created DeleteEntryTypeOperation, possibly from a different process.
func (*CatalogClient) DeleteOperation ¶ added in v1.15.0
func (c *CatalogClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.DeleteOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest. } err = c.DeleteOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*CatalogClient) GetAspectType ¶ added in v1.15.0
func (c *CatalogClient) GetAspectType(ctx context.Context, req *dataplexpb.GetAspectTypeRequest, opts ...gax.CallOption) (*dataplexpb.AspectType, error)
GetAspectType retrieves a AspectType resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetAspectTypeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetAspectTypeRequest. } resp, err := c.GetAspectType(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) GetEntry ¶ added in v1.15.0
func (c *CatalogClient) GetEntry(ctx context.Context, req *dataplexpb.GetEntryRequest, opts ...gax.CallOption) (*dataplexpb.Entry, error)
GetEntry gets a single entry.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetEntryRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetEntryRequest. } resp, err := c.GetEntry(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) GetEntryGroup ¶ added in v1.15.0
func (c *CatalogClient) GetEntryGroup(ctx context.Context, req *dataplexpb.GetEntryGroupRequest, opts ...gax.CallOption) (*dataplexpb.EntryGroup, error)
GetEntryGroup retrieves a EntryGroup resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetEntryGroupRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetEntryGroupRequest. } resp, err := c.GetEntryGroup(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) GetEntryType ¶ added in v1.15.0
func (c *CatalogClient) GetEntryType(ctx context.Context, req *dataplexpb.GetEntryTypeRequest, opts ...gax.CallOption) (*dataplexpb.EntryType, error)
GetEntryType retrieves a EntryType resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetEntryTypeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetEntryTypeRequest. } resp, err := c.GetEntryType(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) GetLocation ¶ added in v1.15.0
func (c *CatalogClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.GetLocationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest. } resp, err := c.GetLocation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) GetOperation ¶ added in v1.15.0
func (c *CatalogClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.GetOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest. } resp, err := c.GetOperation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) ListAspectTypes ¶ added in v1.15.0
func (c *CatalogClient) ListAspectTypes(ctx context.Context, req *dataplexpb.ListAspectTypesRequest, opts ...gax.CallOption) *AspectTypeIterator
ListAspectTypes lists AspectType resources in a project and location.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListAspectTypesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListAspectTypesRequest. } it := c.ListAspectTypes(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*CatalogClient) ListEntries ¶ added in v1.15.0
func (c *CatalogClient) ListEntries(ctx context.Context, req *dataplexpb.ListEntriesRequest, opts ...gax.CallOption) *EntryIterator
ListEntries lists entries within an entry group.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListEntriesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListEntriesRequest. } it := c.ListEntries(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*CatalogClient) ListEntryGroups ¶ added in v1.15.0
func (c *CatalogClient) ListEntryGroups(ctx context.Context, req *dataplexpb.ListEntryGroupsRequest, opts ...gax.CallOption) *EntryGroupIterator
ListEntryGroups lists EntryGroup resources in a project and location.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListEntryGroupsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListEntryGroupsRequest. } it := c.ListEntryGroups(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*CatalogClient) ListEntryTypes ¶ added in v1.15.0
func (c *CatalogClient) ListEntryTypes(ctx context.Context, req *dataplexpb.ListEntryTypesRequest, opts ...gax.CallOption) *EntryTypeIterator
ListEntryTypes lists EntryType resources in a project and location.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListEntryTypesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListEntryTypesRequest. } it := c.ListEntryTypes(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*CatalogClient) ListLocations ¶ added in v1.15.0
func (c *CatalogClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
ListLocations lists information about the supported locations for this service.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" "google.golang.org/api/iterator" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } it := c.ListLocations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*CatalogClient) ListOperations ¶ added in v1.15.0
func (c *CatalogClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } it := c.ListOperations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*CatalogClient) LookupEntry ¶ added in v1.15.0
func (c *CatalogClient) LookupEntry(ctx context.Context, req *dataplexpb.LookupEntryRequest, opts ...gax.CallOption) (*dataplexpb.Entry, error)
LookupEntry looks up a single entry.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.LookupEntryRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#LookupEntryRequest. } resp, err := c.LookupEntry(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) SearchEntries ¶ added in v1.15.0
func (c *CatalogClient) SearchEntries(ctx context.Context, req *dataplexpb.SearchEntriesRequest, opts ...gax.CallOption) *SearchEntriesResultIterator
SearchEntries searches for entries matching given query and scope.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.SearchEntriesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#SearchEntriesRequest. } it := c.SearchEntries(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*CatalogClient) UpdateAspectType ¶ added in v1.15.0
func (c *CatalogClient) UpdateAspectType(ctx context.Context, req *dataplexpb.UpdateAspectTypeRequest, opts ...gax.CallOption) (*UpdateAspectTypeOperation, error)
UpdateAspectType updates a AspectType resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.UpdateAspectTypeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateAspectTypeRequest. } op, err := c.UpdateAspectType(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) UpdateAspectTypeOperation ¶ added in v1.15.0
func (c *CatalogClient) UpdateAspectTypeOperation(name string) *UpdateAspectTypeOperation
UpdateAspectTypeOperation returns a new UpdateAspectTypeOperation from a given name. The name must be that of a previously created UpdateAspectTypeOperation, possibly from a different process.
func (*CatalogClient) UpdateEntry ¶ added in v1.15.0
func (c *CatalogClient) UpdateEntry(ctx context.Context, req *dataplexpb.UpdateEntryRequest, opts ...gax.CallOption) (*dataplexpb.Entry, error)
UpdateEntry updates an Entry.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.UpdateEntryRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateEntryRequest. } resp, err := c.UpdateEntry(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) UpdateEntryGroup ¶ added in v1.15.0
func (c *CatalogClient) UpdateEntryGroup(ctx context.Context, req *dataplexpb.UpdateEntryGroupRequest, opts ...gax.CallOption) (*UpdateEntryGroupOperation, error)
UpdateEntryGroup updates a EntryGroup resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.UpdateEntryGroupRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateEntryGroupRequest. } op, err := c.UpdateEntryGroup(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) UpdateEntryGroupOperation ¶ added in v1.15.0
func (c *CatalogClient) UpdateEntryGroupOperation(name string) *UpdateEntryGroupOperation
UpdateEntryGroupOperation returns a new UpdateEntryGroupOperation from a given name. The name must be that of a previously created UpdateEntryGroupOperation, possibly from a different process.
func (*CatalogClient) UpdateEntryType ¶ added in v1.15.0
func (c *CatalogClient) UpdateEntryType(ctx context.Context, req *dataplexpb.UpdateEntryTypeRequest, opts ...gax.CallOption) (*UpdateEntryTypeOperation, error)
UpdateEntryType updates a EntryType resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewCatalogClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.UpdateEntryTypeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateEntryTypeRequest. } op, err := c.UpdateEntryType(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*CatalogClient) UpdateEntryTypeOperation ¶ added in v1.15.0
func (c *CatalogClient) UpdateEntryTypeOperation(name string) *UpdateEntryTypeOperation
UpdateEntryTypeOperation returns a new UpdateEntryTypeOperation from a given name. The name must be that of a previously created UpdateEntryTypeOperation, possibly from a different process.
type Client ¶
type Client struct { // The call options for this service. CallOptions *CallOptions // LROClient is used internally to handle long-running operations. // It is exposed so that its CallOptions can be modified if required. // Users should not Close this client. LROClient *lroauto.OperationsClient // contains filtered or unexported fields }
Client is a client for interacting with Cloud Dataplex API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Dataplex service provides data lakes as a service. The primary resources offered by this service are Lakes, Zones and Assets which collectively allow a data administrator to organize, manage, secure and catalog data across their organization located across cloud projects in a variety of storage systems including Cloud Storage and BigQuery.
func NewClient ¶
NewClient creates a new dataplex service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Dataplex service provides data lakes as a service. The primary resources offered by this service are Lakes, Zones and Assets which collectively allow a data administrator to organize, manage, secure and catalog data across their organization located across cloud projects in a variety of storage systems including Cloud Storage and BigQuery.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*Client) CancelJob ¶
func (c *Client) CancelJob(ctx context.Context, req *dataplexpb.CancelJobRequest, opts ...gax.CallOption) error
CancelJob cancel jobs running for the task resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CancelJobRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CancelJobRequest. } err = c.CancelJob(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) CancelOperation ¶ added in v1.1.0
func (c *Client) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) Close ¶
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection
deprecated
func (c *Client) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*Client) CreateAsset ¶
func (c *Client) CreateAsset(ctx context.Context, req *dataplexpb.CreateAssetRequest, opts ...gax.CallOption) (*CreateAssetOperation, error)
CreateAsset creates an asset resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreateAssetRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateAssetRequest. } op, err := c.CreateAsset(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreateAssetOperation ¶
func (c *Client) CreateAssetOperation(name string) *CreateAssetOperation
CreateAssetOperation returns a new CreateAssetOperation from a given name. The name must be that of a previously created CreateAssetOperation, possibly from a different process.
func (*Client) CreateEnvironment ¶ added in v0.3.0
func (c *Client) CreateEnvironment(ctx context.Context, req *dataplexpb.CreateEnvironmentRequest, opts ...gax.CallOption) (*CreateEnvironmentOperation, error)
CreateEnvironment create an environment resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreateEnvironmentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateEnvironmentRequest. } op, err := c.CreateEnvironment(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreateEnvironmentOperation ¶ added in v0.3.0
func (c *Client) CreateEnvironmentOperation(name string) *CreateEnvironmentOperation
CreateEnvironmentOperation returns a new CreateEnvironmentOperation from a given name. The name must be that of a previously created CreateEnvironmentOperation, possibly from a different process.
func (*Client) CreateLake ¶
func (c *Client) CreateLake(ctx context.Context, req *dataplexpb.CreateLakeRequest, opts ...gax.CallOption) (*CreateLakeOperation, error)
CreateLake creates a lake resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreateLakeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateLakeRequest. } op, err := c.CreateLake(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreateLakeOperation ¶
func (c *Client) CreateLakeOperation(name string) *CreateLakeOperation
CreateLakeOperation returns a new CreateLakeOperation from a given name. The name must be that of a previously created CreateLakeOperation, possibly from a different process.
func (*Client) CreateTask ¶
func (c *Client) CreateTask(ctx context.Context, req *dataplexpb.CreateTaskRequest, opts ...gax.CallOption) (*CreateTaskOperation, error)
CreateTask creates a task resource within a lake.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreateTaskRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateTaskRequest. } op, err := c.CreateTask(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreateTaskOperation ¶
func (c *Client) CreateTaskOperation(name string) *CreateTaskOperation
CreateTaskOperation returns a new CreateTaskOperation from a given name. The name must be that of a previously created CreateTaskOperation, possibly from a different process.
func (*Client) CreateZone ¶
func (c *Client) CreateZone(ctx context.Context, req *dataplexpb.CreateZoneRequest, opts ...gax.CallOption) (*CreateZoneOperation, error)
CreateZone creates a zone resource within a lake.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreateZoneRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateZoneRequest. } op, err := c.CreateZone(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) CreateZoneOperation ¶
func (c *Client) CreateZoneOperation(name string) *CreateZoneOperation
CreateZoneOperation returns a new CreateZoneOperation from a given name. The name must be that of a previously created CreateZoneOperation, possibly from a different process.
func (*Client) DeleteAsset ¶
func (c *Client) DeleteAsset(ctx context.Context, req *dataplexpb.DeleteAssetRequest, opts ...gax.CallOption) (*DeleteAssetOperation, error)
DeleteAsset deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeleteAssetRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteAssetRequest. } op, err := c.DeleteAsset(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeleteAssetOperation ¶
func (c *Client) DeleteAssetOperation(name string) *DeleteAssetOperation
DeleteAssetOperation returns a new DeleteAssetOperation from a given name. The name must be that of a previously created DeleteAssetOperation, possibly from a different process.
func (*Client) DeleteEnvironment ¶ added in v0.3.0
func (c *Client) DeleteEnvironment(ctx context.Context, req *dataplexpb.DeleteEnvironmentRequest, opts ...gax.CallOption) (*DeleteEnvironmentOperation, error)
DeleteEnvironment delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeleteEnvironmentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteEnvironmentRequest. } op, err := c.DeleteEnvironment(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeleteEnvironmentOperation ¶ added in v0.3.0
func (c *Client) DeleteEnvironmentOperation(name string) *DeleteEnvironmentOperation
DeleteEnvironmentOperation returns a new DeleteEnvironmentOperation from a given name. The name must be that of a previously created DeleteEnvironmentOperation, possibly from a different process.
func (*Client) DeleteLake ¶
func (c *Client) DeleteLake(ctx context.Context, req *dataplexpb.DeleteLakeRequest, opts ...gax.CallOption) (*DeleteLakeOperation, error)
DeleteLake deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeleteLakeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteLakeRequest. } op, err := c.DeleteLake(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeleteLakeOperation ¶
func (c *Client) DeleteLakeOperation(name string) *DeleteLakeOperation
DeleteLakeOperation returns a new DeleteLakeOperation from a given name. The name must be that of a previously created DeleteLakeOperation, possibly from a different process.
func (*Client) DeleteOperation ¶ added in v1.1.0
func (c *Client) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.DeleteOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest. } err = c.DeleteOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeleteTask ¶
func (c *Client) DeleteTask(ctx context.Context, req *dataplexpb.DeleteTaskRequest, opts ...gax.CallOption) (*DeleteTaskOperation, error)
DeleteTask delete the task resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeleteTaskRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteTaskRequest. } op, err := c.DeleteTask(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeleteTaskOperation ¶
func (c *Client) DeleteTaskOperation(name string) *DeleteTaskOperation
DeleteTaskOperation returns a new DeleteTaskOperation from a given name. The name must be that of a previously created DeleteTaskOperation, possibly from a different process.
func (*Client) DeleteZone ¶
func (c *Client) DeleteZone(ctx context.Context, req *dataplexpb.DeleteZoneRequest, opts ...gax.CallOption) (*DeleteZoneOperation, error)
DeleteZone deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeleteZoneRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteZoneRequest. } op, err := c.DeleteZone(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*Client) DeleteZoneOperation ¶
func (c *Client) DeleteZoneOperation(name string) *DeleteZoneOperation
DeleteZoneOperation returns a new DeleteZoneOperation from a given name. The name must be that of a previously created DeleteZoneOperation, possibly from a different process.
func (*Client) GetAsset ¶
func (c *Client) GetAsset(ctx context.Context, req *dataplexpb.GetAssetRequest, opts ...gax.CallOption) (*dataplexpb.Asset, error)
GetAsset retrieves an asset resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetAssetRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetAssetRequest. } resp, err := c.GetAsset(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetEnvironment ¶ added in v0.3.0
func (c *Client) GetEnvironment(ctx context.Context, req *dataplexpb.GetEnvironmentRequest, opts ...gax.CallOption) (*dataplexpb.Environment, error)
GetEnvironment get environment resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetEnvironmentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetEnvironmentRequest. } resp, err := c.GetEnvironment(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetJob ¶
func (c *Client) GetJob(ctx context.Context, req *dataplexpb.GetJobRequest, opts ...gax.CallOption) (*dataplexpb.Job, error)
GetJob get job resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetJobRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetJobRequest. } resp, err := c.GetJob(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetLake ¶
func (c *Client) GetLake(ctx context.Context, req *dataplexpb.GetLakeRequest, opts ...gax.CallOption) (*dataplexpb.Lake, error)
GetLake retrieves a lake resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetLakeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetLakeRequest. } resp, err := c.GetLake(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetLocation ¶ added in v1.1.0
func (c *Client) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.GetLocationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest. } resp, err := c.GetLocation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetOperation ¶ added in v1.1.0
func (c *Client) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.GetOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest. } resp, err := c.GetOperation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetTask ¶
func (c *Client) GetTask(ctx context.Context, req *dataplexpb.GetTaskRequest, opts ...gax.CallOption) (*dataplexpb.Task, error)
GetTask get task resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetTaskRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetTaskRequest. } resp, err := c.GetTask(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) GetZone ¶
func (c *Client) GetZone(ctx context.Context, req *dataplexpb.GetZoneRequest, opts ...gax.CallOption) (*dataplexpb.Zone, error)
GetZone retrieves a zone resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetZoneRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetZoneRequest. } resp, err := c.GetZone(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) ListAssetActions ¶
func (c *Client) ListAssetActions(ctx context.Context, req *dataplexpb.ListAssetActionsRequest, opts ...gax.CallOption) *ActionIterator
ListAssetActions lists action resources in an asset.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListAssetActionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListAssetActionsRequest. } it := c.ListAssetActions(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListAssets ¶
func (c *Client) ListAssets(ctx context.Context, req *dataplexpb.ListAssetsRequest, opts ...gax.CallOption) *AssetIterator
ListAssets lists asset resources in a zone.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListAssetsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListAssetsRequest. } it := c.ListAssets(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListEnvironments ¶ added in v0.3.0
func (c *Client) ListEnvironments(ctx context.Context, req *dataplexpb.ListEnvironmentsRequest, opts ...gax.CallOption) *EnvironmentIterator
ListEnvironments lists environments under the given lake.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListEnvironmentsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListEnvironmentsRequest. } it := c.ListEnvironments(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListJobs ¶
func (c *Client) ListJobs(ctx context.Context, req *dataplexpb.ListJobsRequest, opts ...gax.CallOption) *JobIterator
ListJobs lists Jobs under the given task.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListJobsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListJobsRequest. } it := c.ListJobs(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListLakeActions ¶
func (c *Client) ListLakeActions(ctx context.Context, req *dataplexpb.ListLakeActionsRequest, opts ...gax.CallOption) *ActionIterator
ListLakeActions lists action resources in a lake.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListLakeActionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListLakeActionsRequest. } it := c.ListLakeActions(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListLakes ¶
func (c *Client) ListLakes(ctx context.Context, req *dataplexpb.ListLakesRequest, opts ...gax.CallOption) *LakeIterator
ListLakes lists lake resources in a project and location.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListLakesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListLakesRequest. } it := c.ListLakes(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListLocations ¶ added in v1.1.0
func (c *Client) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
ListLocations lists information about the supported locations for this service.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" "google.golang.org/api/iterator" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } it := c.ListLocations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListOperations ¶ added in v1.1.0
func (c *Client) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } it := c.ListOperations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListSessions ¶ added in v0.3.0
func (c *Client) ListSessions(ctx context.Context, req *dataplexpb.ListSessionsRequest, opts ...gax.CallOption) *SessionIterator
ListSessions lists session resources in an environment.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListSessionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListSessionsRequest. } it := c.ListSessions(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListTasks ¶
func (c *Client) ListTasks(ctx context.Context, req *dataplexpb.ListTasksRequest, opts ...gax.CallOption) *TaskIterator
ListTasks lists tasks under the given lake.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListTasksRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListTasksRequest. } it := c.ListTasks(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListZoneActions ¶
func (c *Client) ListZoneActions(ctx context.Context, req *dataplexpb.ListZoneActionsRequest, opts ...gax.CallOption) *ActionIterator
ListZoneActions lists action resources in a zone.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListZoneActionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListZoneActionsRequest. } it := c.ListZoneActions(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) ListZones ¶
func (c *Client) ListZones(ctx context.Context, req *dataplexpb.ListZonesRequest, opts ...gax.CallOption) *ZoneIterator
ListZones lists zone resources in a lake.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListZonesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListZonesRequest. } it := c.ListZones(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*Client) RunTask ¶ added in v1.7.0
func (c *Client) RunTask(ctx context.Context, req *dataplexpb.RunTaskRequest, opts ...gax.CallOption) (*dataplexpb.RunTaskResponse, error)
RunTask run an on demand execution of a Task.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.RunTaskRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#RunTaskRequest. } resp, err := c.RunTask(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UpdateAsset ¶
func (c *Client) UpdateAsset(ctx context.Context, req *dataplexpb.UpdateAssetRequest, opts ...gax.CallOption) (*UpdateAssetOperation, error)
UpdateAsset updates an asset resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.UpdateAssetRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateAssetRequest. } op, err := c.UpdateAsset(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UpdateAssetOperation ¶
func (c *Client) UpdateAssetOperation(name string) *UpdateAssetOperation
UpdateAssetOperation returns a new UpdateAssetOperation from a given name. The name must be that of a previously created UpdateAssetOperation, possibly from a different process.
func (*Client) UpdateEnvironment ¶ added in v0.3.0
func (c *Client) UpdateEnvironment(ctx context.Context, req *dataplexpb.UpdateEnvironmentRequest, opts ...gax.CallOption) (*UpdateEnvironmentOperation, error)
UpdateEnvironment update the environment resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.UpdateEnvironmentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateEnvironmentRequest. } op, err := c.UpdateEnvironment(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UpdateEnvironmentOperation ¶ added in v0.3.0
func (c *Client) UpdateEnvironmentOperation(name string) *UpdateEnvironmentOperation
UpdateEnvironmentOperation returns a new UpdateEnvironmentOperation from a given name. The name must be that of a previously created UpdateEnvironmentOperation, possibly from a different process.
func (*Client) UpdateLake ¶
func (c *Client) UpdateLake(ctx context.Context, req *dataplexpb.UpdateLakeRequest, opts ...gax.CallOption) (*UpdateLakeOperation, error)
UpdateLake updates a lake resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.UpdateLakeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateLakeRequest. } op, err := c.UpdateLake(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UpdateLakeOperation ¶
func (c *Client) UpdateLakeOperation(name string) *UpdateLakeOperation
UpdateLakeOperation returns a new UpdateLakeOperation from a given name. The name must be that of a previously created UpdateLakeOperation, possibly from a different process.
func (*Client) UpdateTask ¶
func (c *Client) UpdateTask(ctx context.Context, req *dataplexpb.UpdateTaskRequest, opts ...gax.CallOption) (*UpdateTaskOperation, error)
UpdateTask update the task resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.UpdateTaskRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateTaskRequest. } op, err := c.UpdateTask(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UpdateTaskOperation ¶
func (c *Client) UpdateTaskOperation(name string) *UpdateTaskOperation
UpdateTaskOperation returns a new UpdateTaskOperation from a given name. The name must be that of a previously created UpdateTaskOperation, possibly from a different process.
func (*Client) UpdateZone ¶
func (c *Client) UpdateZone(ctx context.Context, req *dataplexpb.UpdateZoneRequest, opts ...gax.CallOption) (*UpdateZoneOperation, error)
UpdateZone updates a zone resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.UpdateZoneRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateZoneRequest. } op, err := c.UpdateZone(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) UpdateZoneOperation ¶
func (c *Client) UpdateZoneOperation(name string) *UpdateZoneOperation
UpdateZoneOperation returns a new UpdateZoneOperation from a given name. The name must be that of a previously created UpdateZoneOperation, possibly from a different process.
type ContentCallOptions ¶ added in v0.3.0
type ContentCallOptions struct { CreateContent []gax.CallOption UpdateContent []gax.CallOption DeleteContent []gax.CallOption GetContent []gax.CallOption GetIamPolicy []gax.CallOption SetIamPolicy []gax.CallOption TestIamPermissions []gax.CallOption ListContent []gax.CallOption GetLocation []gax.CallOption ListLocations []gax.CallOption CancelOperation []gax.CallOption DeleteOperation []gax.CallOption GetOperation []gax.CallOption ListOperations []gax.CallOption }
ContentCallOptions contains the retry settings for each method of ContentClient.
type ContentClient ¶ added in v0.3.0
type ContentClient struct { // The call options for this service. CallOptions *ContentCallOptions // contains filtered or unexported fields }
ContentClient is a client for interacting with Cloud Dataplex API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
ContentService manages Notebook and SQL Scripts for Dataplex.
func NewContentClient ¶ added in v0.3.0
func NewContentClient(ctx context.Context, opts ...option.ClientOption) (*ContentClient, error)
NewContentClient creates a new content service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
ContentService manages Notebook and SQL Scripts for Dataplex.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewContentClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*ContentClient) CancelOperation ¶ added in v1.1.0
func (c *ContentClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewContentClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*ContentClient) Close ¶ added in v0.3.0
func (c *ContentClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*ContentClient) Connection
deprecated
added in
v0.3.0
func (c *ContentClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*ContentClient) CreateContent ¶ added in v0.3.0
func (c *ContentClient) CreateContent(ctx context.Context, req *dataplexpb.CreateContentRequest, opts ...gax.CallOption) (*dataplexpb.Content, error)
CreateContent create a content.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewContentClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreateContentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateContentRequest. } resp, err := c.CreateContent(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*ContentClient) DeleteContent ¶ added in v0.3.0
func (c *ContentClient) DeleteContent(ctx context.Context, req *dataplexpb.DeleteContentRequest, opts ...gax.CallOption) error
DeleteContent delete a content.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewContentClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeleteContentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteContentRequest. } err = c.DeleteContent(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*ContentClient) DeleteOperation ¶ added in v1.1.0
func (c *ContentClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewContentClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.DeleteOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest. } err = c.DeleteOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*ContentClient) GetContent ¶ added in v0.3.0
func (c *ContentClient) GetContent(ctx context.Context, req *dataplexpb.GetContentRequest, opts ...gax.CallOption) (*dataplexpb.Content, error)
GetContent get a content resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewContentClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetContentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetContentRequest. } resp, err := c.GetContent(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*ContentClient) GetIamPolicy ¶ added in v1.1.0
func (c *ContentClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
GetIamPolicy gets the access control policy for a contentitem resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
Caller must have Google IAM dataplex.content.getIamPolicy permission on the resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" iampb "cloud.google.com/go/iam/apiv1/iampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewContentClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.GetIamPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#GetIamPolicyRequest. } resp, err := c.GetIamPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*ContentClient) GetLocation ¶ added in v1.1.0
func (c *ContentClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewContentClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.GetLocationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest. } resp, err := c.GetLocation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*ContentClient) GetOperation ¶ added in v1.1.0
func (c *ContentClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewContentClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.GetOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest. } resp, err := c.GetOperation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*ContentClient) ListContent ¶ added in v0.3.0
func (c *ContentClient) ListContent(ctx context.Context, req *dataplexpb.ListContentRequest, opts ...gax.CallOption) *ContentIterator
ListContent list content.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewContentClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListContentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListContentRequest. } it := c.ListContent(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*ContentClient) ListLocations ¶ added in v1.1.0
func (c *ContentClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
ListLocations lists information about the supported locations for this service.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" "google.golang.org/api/iterator" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewContentClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } it := c.ListLocations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*ContentClient) ListOperations ¶ added in v1.1.0
func (c *ContentClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewContentClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } it := c.ListOperations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*ContentClient) SetIamPolicy ¶ added in v1.1.0
func (c *ContentClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
SetIamPolicy sets the access control policy on the specified contentitem resource. Replaces any existing policy.
Caller must have Google IAM dataplex.content.setIamPolicy permission on the resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" iampb "cloud.google.com/go/iam/apiv1/iampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewContentClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.SetIamPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#SetIamPolicyRequest. } resp, err := c.SetIamPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*ContentClient) TestIamPermissions ¶ added in v1.1.0
func (c *ContentClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)
TestIamPermissions returns the caller’s permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a NOT_FOUND error is not returned).
A caller is not required to have Google IAM permission to make this request.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" iampb "cloud.google.com/go/iam/apiv1/iampb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewContentClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.TestIamPermissionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#TestIamPermissionsRequest. } resp, err := c.TestIamPermissions(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*ContentClient) UpdateContent ¶ added in v0.3.0
func (c *ContentClient) UpdateContent(ctx context.Context, req *dataplexpb.UpdateContentRequest, opts ...gax.CallOption) (*dataplexpb.Content, error)
UpdateContent update a content. Only supports full resource update.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewContentClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.UpdateContentRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateContentRequest. } resp, err := c.UpdateContent(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
type ContentIterator ¶ added in v0.3.0
type ContentIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.Content, nextPageToken string, err error) // contains filtered or unexported fields }
ContentIterator manages a stream of *dataplexpb.Content.
func (*ContentIterator) Next ¶ added in v0.3.0
func (it *ContentIterator) Next() (*dataplexpb.Content, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ContentIterator) PageInfo ¶ added in v0.3.0
func (it *ContentIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type CreateAspectTypeOperation ¶ added in v1.15.0
type CreateAspectTypeOperation struct {
// contains filtered or unexported fields
}
CreateAspectTypeOperation manages a long-running operation from CreateAspectType.
func (*CreateAspectTypeOperation) Done ¶ added in v1.15.0
func (op *CreateAspectTypeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateAspectTypeOperation) Metadata ¶ added in v1.15.0
func (op *CreateAspectTypeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateAspectTypeOperation) Name ¶ added in v1.15.0
func (op *CreateAspectTypeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateAspectTypeOperation) Poll ¶ added in v1.15.0
func (op *CreateAspectTypeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.AspectType, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateAspectTypeOperation) Wait ¶ added in v1.15.0
func (op *CreateAspectTypeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.AspectType, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type CreateAssetOperation ¶
type CreateAssetOperation struct {
// contains filtered or unexported fields
}
CreateAssetOperation manages a long-running operation from CreateAsset.
func (*CreateAssetOperation) Done ¶
func (op *CreateAssetOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateAssetOperation) Metadata ¶
func (op *CreateAssetOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateAssetOperation) Name ¶
func (op *CreateAssetOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateAssetOperation) Poll ¶
func (op *CreateAssetOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Asset, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateAssetOperation) Wait ¶
func (op *CreateAssetOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Asset, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type CreateDataAttributeBindingOperation ¶ added in v1.9.0
type CreateDataAttributeBindingOperation struct {
// contains filtered or unexported fields
}
CreateDataAttributeBindingOperation manages a long-running operation from CreateDataAttributeBinding.
func (*CreateDataAttributeBindingOperation) Done ¶ added in v1.9.0
func (op *CreateDataAttributeBindingOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateDataAttributeBindingOperation) Metadata ¶ added in v1.9.0
func (op *CreateDataAttributeBindingOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateDataAttributeBindingOperation) Name ¶ added in v1.9.0
func (op *CreateDataAttributeBindingOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateDataAttributeBindingOperation) Poll ¶ added in v1.9.0
func (op *CreateDataAttributeBindingOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttributeBinding, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateDataAttributeBindingOperation) Wait ¶ added in v1.9.0
func (op *CreateDataAttributeBindingOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttributeBinding, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type CreateDataAttributeOperation ¶ added in v1.9.0
type CreateDataAttributeOperation struct {
// contains filtered or unexported fields
}
CreateDataAttributeOperation manages a long-running operation from CreateDataAttribute.
func (*CreateDataAttributeOperation) Done ¶ added in v1.9.0
func (op *CreateDataAttributeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateDataAttributeOperation) Metadata ¶ added in v1.9.0
func (op *CreateDataAttributeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateDataAttributeOperation) Name ¶ added in v1.9.0
func (op *CreateDataAttributeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateDataAttributeOperation) Poll ¶ added in v1.9.0
func (op *CreateDataAttributeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttribute, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateDataAttributeOperation) Wait ¶ added in v1.9.0
func (op *CreateDataAttributeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttribute, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type CreateDataScanOperation ¶ added in v1.5.0
type CreateDataScanOperation struct {
// contains filtered or unexported fields
}
CreateDataScanOperation manages a long-running operation from CreateDataScan.
func (*CreateDataScanOperation) Done ¶ added in v1.5.0
func (op *CreateDataScanOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateDataScanOperation) Metadata ¶ added in v1.5.0
func (op *CreateDataScanOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateDataScanOperation) Name ¶ added in v1.5.0
func (op *CreateDataScanOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateDataScanOperation) Poll ¶ added in v1.5.0
func (op *CreateDataScanOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataScan, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateDataScanOperation) Wait ¶ added in v1.5.0
func (op *CreateDataScanOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataScan, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type CreateDataTaxonomyOperation ¶ added in v1.9.0
type CreateDataTaxonomyOperation struct {
// contains filtered or unexported fields
}
CreateDataTaxonomyOperation manages a long-running operation from CreateDataTaxonomy.
func (*CreateDataTaxonomyOperation) Done ¶ added in v1.9.0
func (op *CreateDataTaxonomyOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateDataTaxonomyOperation) Metadata ¶ added in v1.9.0
func (op *CreateDataTaxonomyOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateDataTaxonomyOperation) Name ¶ added in v1.9.0
func (op *CreateDataTaxonomyOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateDataTaxonomyOperation) Poll ¶ added in v1.9.0
func (op *CreateDataTaxonomyOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataTaxonomy, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateDataTaxonomyOperation) Wait ¶ added in v1.9.0
func (op *CreateDataTaxonomyOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataTaxonomy, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type CreateEntryGroupOperation ¶ added in v1.15.0
type CreateEntryGroupOperation struct {
// contains filtered or unexported fields
}
CreateEntryGroupOperation manages a long-running operation from CreateEntryGroup.
func (*CreateEntryGroupOperation) Done ¶ added in v1.15.0
func (op *CreateEntryGroupOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateEntryGroupOperation) Metadata ¶ added in v1.15.0
func (op *CreateEntryGroupOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateEntryGroupOperation) Name ¶ added in v1.15.0
func (op *CreateEntryGroupOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateEntryGroupOperation) Poll ¶ added in v1.15.0
func (op *CreateEntryGroupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryGroup, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateEntryGroupOperation) Wait ¶ added in v1.15.0
func (op *CreateEntryGroupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryGroup, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type CreateEntryTypeOperation ¶ added in v1.15.0
type CreateEntryTypeOperation struct {
// contains filtered or unexported fields
}
CreateEntryTypeOperation manages a long-running operation from CreateEntryType.
func (*CreateEntryTypeOperation) Done ¶ added in v1.15.0
func (op *CreateEntryTypeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateEntryTypeOperation) Metadata ¶ added in v1.15.0
func (op *CreateEntryTypeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateEntryTypeOperation) Name ¶ added in v1.15.0
func (op *CreateEntryTypeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateEntryTypeOperation) Poll ¶ added in v1.15.0
func (op *CreateEntryTypeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryType, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateEntryTypeOperation) Wait ¶ added in v1.15.0
func (op *CreateEntryTypeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryType, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type CreateEnvironmentOperation ¶ added in v0.3.0
type CreateEnvironmentOperation struct {
// contains filtered or unexported fields
}
CreateEnvironmentOperation manages a long-running operation from CreateEnvironment.
func (*CreateEnvironmentOperation) Done ¶ added in v0.3.0
func (op *CreateEnvironmentOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateEnvironmentOperation) Metadata ¶ added in v0.3.0
func (op *CreateEnvironmentOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateEnvironmentOperation) Name ¶ added in v0.3.0
func (op *CreateEnvironmentOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateEnvironmentOperation) Poll ¶ added in v0.3.0
func (op *CreateEnvironmentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Environment, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateEnvironmentOperation) Wait ¶ added in v0.3.0
func (op *CreateEnvironmentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Environment, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type CreateLakeOperation ¶
type CreateLakeOperation struct {
// contains filtered or unexported fields
}
CreateLakeOperation manages a long-running operation from CreateLake.
func (*CreateLakeOperation) Done ¶
func (op *CreateLakeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateLakeOperation) Metadata ¶
func (op *CreateLakeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateLakeOperation) Name ¶
func (op *CreateLakeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateLakeOperation) Poll ¶
func (op *CreateLakeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Lake, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateLakeOperation) Wait ¶
func (op *CreateLakeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Lake, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type CreateTaskOperation ¶
type CreateTaskOperation struct {
// contains filtered or unexported fields
}
CreateTaskOperation manages a long-running operation from CreateTask.
func (*CreateTaskOperation) Done ¶
func (op *CreateTaskOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateTaskOperation) Metadata ¶
func (op *CreateTaskOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateTaskOperation) Name ¶
func (op *CreateTaskOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateTaskOperation) Poll ¶
func (op *CreateTaskOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Task, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateTaskOperation) Wait ¶
func (op *CreateTaskOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Task, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type CreateZoneOperation ¶
type CreateZoneOperation struct {
// contains filtered or unexported fields
}
CreateZoneOperation manages a long-running operation from CreateZone.
func (*CreateZoneOperation) Done ¶
func (op *CreateZoneOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateZoneOperation) Metadata ¶
func (op *CreateZoneOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateZoneOperation) Name ¶
func (op *CreateZoneOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateZoneOperation) Poll ¶
func (op *CreateZoneOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Zone, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateZoneOperation) Wait ¶
func (op *CreateZoneOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Zone, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DataAttributeBindingIterator ¶ added in v1.9.0
type DataAttributeBindingIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.DataAttributeBinding, nextPageToken string, err error) // contains filtered or unexported fields }
DataAttributeBindingIterator manages a stream of *dataplexpb.DataAttributeBinding.
func (*DataAttributeBindingIterator) Next ¶ added in v1.9.0
func (it *DataAttributeBindingIterator) Next() (*dataplexpb.DataAttributeBinding, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*DataAttributeBindingIterator) PageInfo ¶ added in v1.9.0
func (it *DataAttributeBindingIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type DataAttributeIterator ¶ added in v1.9.0
type DataAttributeIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.DataAttribute, nextPageToken string, err error) // contains filtered or unexported fields }
DataAttributeIterator manages a stream of *dataplexpb.DataAttribute.
func (*DataAttributeIterator) Next ¶ added in v1.9.0
func (it *DataAttributeIterator) Next() (*dataplexpb.DataAttribute, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*DataAttributeIterator) PageInfo ¶ added in v1.9.0
func (it *DataAttributeIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type DataScanCallOptions ¶ added in v1.5.0
type DataScanCallOptions struct { CreateDataScan []gax.CallOption UpdateDataScan []gax.CallOption DeleteDataScan []gax.CallOption GetDataScan []gax.CallOption ListDataScans []gax.CallOption RunDataScan []gax.CallOption GetDataScanJob []gax.CallOption ListDataScanJobs []gax.CallOption GenerateDataQualityRules []gax.CallOption GetLocation []gax.CallOption ListLocations []gax.CallOption CancelOperation []gax.CallOption DeleteOperation []gax.CallOption GetOperation []gax.CallOption ListOperations []gax.CallOption }
DataScanCallOptions contains the retry settings for each method of DataScanClient.
type DataScanClient ¶ added in v1.5.0
type DataScanClient struct { // The call options for this service. CallOptions *DataScanCallOptions // LROClient is used internally to handle long-running operations. // It is exposed so that its CallOptions can be modified if required. // Users should not Close this client. LROClient *lroauto.OperationsClient // contains filtered or unexported fields }
DataScanClient is a client for interacting with Cloud Dataplex API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
DataScanService manages DataScan resources which can be configured to run various types of data scanning workload and generate enriched metadata (e.g. Data Profile, Data Quality) for the data source.
func NewDataScanClient ¶ added in v1.5.0
func NewDataScanClient(ctx context.Context, opts ...option.ClientOption) (*DataScanClient, error)
NewDataScanClient creates a new data scan service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
DataScanService manages DataScan resources which can be configured to run various types of data scanning workload and generate enriched metadata (e.g. Data Profile, Data Quality) for the data source.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*DataScanClient) CancelOperation ¶ added in v1.5.0
func (c *DataScanClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*DataScanClient) Close ¶ added in v1.5.0
func (c *DataScanClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*DataScanClient) Connection
deprecated
added in
v1.5.0
func (c *DataScanClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*DataScanClient) CreateDataScan ¶ added in v1.5.0
func (c *DataScanClient) CreateDataScan(ctx context.Context, req *dataplexpb.CreateDataScanRequest, opts ...gax.CallOption) (*CreateDataScanOperation, error)
CreateDataScan creates a DataScan resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreateDataScanRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateDataScanRequest. } op, err := c.CreateDataScan(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataScanClient) CreateDataScanOperation ¶ added in v1.5.0
func (c *DataScanClient) CreateDataScanOperation(name string) *CreateDataScanOperation
CreateDataScanOperation returns a new CreateDataScanOperation from a given name. The name must be that of a previously created CreateDataScanOperation, possibly from a different process.
func (*DataScanClient) DeleteDataScan ¶ added in v1.5.0
func (c *DataScanClient) DeleteDataScan(ctx context.Context, req *dataplexpb.DeleteDataScanRequest, opts ...gax.CallOption) (*DeleteDataScanOperation, error)
DeleteDataScan deletes a DataScan resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeleteDataScanRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteDataScanRequest. } op, err := c.DeleteDataScan(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*DataScanClient) DeleteDataScanOperation ¶ added in v1.5.0
func (c *DataScanClient) DeleteDataScanOperation(name string) *DeleteDataScanOperation
DeleteDataScanOperation returns a new DeleteDataScanOperation from a given name. The name must be that of a previously created DeleteDataScanOperation, possibly from a different process.
func (*DataScanClient) DeleteOperation ¶ added in v1.5.0
func (c *DataScanClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.DeleteOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest. } err = c.DeleteOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*DataScanClient) GenerateDataQualityRules ¶ added in v1.15.0
func (c *DataScanClient) GenerateDataQualityRules(ctx context.Context, req *dataplexpb.GenerateDataQualityRulesRequest, opts ...gax.CallOption) (*dataplexpb.GenerateDataQualityRulesResponse, error)
GenerateDataQualityRules generates recommended DataQualityRule from a data profiling DataScan.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GenerateDataQualityRulesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GenerateDataQualityRulesRequest. } resp, err := c.GenerateDataQualityRules(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataScanClient) GetDataScan ¶ added in v1.5.0
func (c *DataScanClient) GetDataScan(ctx context.Context, req *dataplexpb.GetDataScanRequest, opts ...gax.CallOption) (*dataplexpb.DataScan, error)
GetDataScan gets a DataScan resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetDataScanRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetDataScanRequest. } resp, err := c.GetDataScan(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataScanClient) GetDataScanJob ¶ added in v1.5.0
func (c *DataScanClient) GetDataScanJob(ctx context.Context, req *dataplexpb.GetDataScanJobRequest, opts ...gax.CallOption) (*dataplexpb.DataScanJob, error)
GetDataScanJob gets a DataScanJob resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetDataScanJobRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetDataScanJobRequest. } resp, err := c.GetDataScanJob(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataScanClient) GetLocation ¶ added in v1.5.0
func (c *DataScanClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.GetLocationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest. } resp, err := c.GetLocation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataScanClient) GetOperation ¶ added in v1.5.0
func (c *DataScanClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.GetOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest. } resp, err := c.GetOperation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataScanClient) ListDataScanJobs ¶ added in v1.5.0
func (c *DataScanClient) ListDataScanJobs(ctx context.Context, req *dataplexpb.ListDataScanJobsRequest, opts ...gax.CallOption) *DataScanJobIterator
ListDataScanJobs lists DataScanJobs under the given DataScan.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListDataScanJobsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListDataScanJobsRequest. } it := c.ListDataScanJobs(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataScanClient) ListDataScans ¶ added in v1.5.0
func (c *DataScanClient) ListDataScans(ctx context.Context, req *dataplexpb.ListDataScansRequest, opts ...gax.CallOption) *DataScanIterator
ListDataScans lists DataScans.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListDataScansRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListDataScansRequest. } it := c.ListDataScans(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataScanClient) ListLocations ¶ added in v1.5.0
func (c *DataScanClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
ListLocations lists information about the supported locations for this service.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" "google.golang.org/api/iterator" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } it := c.ListLocations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataScanClient) ListOperations ¶ added in v1.5.0
func (c *DataScanClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } it := c.ListOperations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataScanClient) RunDataScan ¶ added in v1.5.0
func (c *DataScanClient) RunDataScan(ctx context.Context, req *dataplexpb.RunDataScanRequest, opts ...gax.CallOption) (*dataplexpb.RunDataScanResponse, error)
RunDataScan runs an on-demand execution of a DataScan
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.RunDataScanRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#RunDataScanRequest. } resp, err := c.RunDataScan(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataScanClient) UpdateDataScan ¶ added in v1.5.0
func (c *DataScanClient) UpdateDataScan(ctx context.Context, req *dataplexpb.UpdateDataScanRequest, opts ...gax.CallOption) (*UpdateDataScanOperation, error)
UpdateDataScan updates a DataScan resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataScanClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.UpdateDataScanRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateDataScanRequest. } op, err := c.UpdateDataScan(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataScanClient) UpdateDataScanOperation ¶ added in v1.5.0
func (c *DataScanClient) UpdateDataScanOperation(name string) *UpdateDataScanOperation
UpdateDataScanOperation returns a new UpdateDataScanOperation from a given name. The name must be that of a previously created UpdateDataScanOperation, possibly from a different process.
type DataScanIterator ¶ added in v1.5.0
type DataScanIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.DataScan, nextPageToken string, err error) // contains filtered or unexported fields }
DataScanIterator manages a stream of *dataplexpb.DataScan.
func (*DataScanIterator) Next ¶ added in v1.5.0
func (it *DataScanIterator) Next() (*dataplexpb.DataScan, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*DataScanIterator) PageInfo ¶ added in v1.5.0
func (it *DataScanIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type DataScanJobIterator ¶ added in v1.5.0
type DataScanJobIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.DataScanJob, nextPageToken string, err error) // contains filtered or unexported fields }
DataScanJobIterator manages a stream of *dataplexpb.DataScanJob.
func (*DataScanJobIterator) Next ¶ added in v1.5.0
func (it *DataScanJobIterator) Next() (*dataplexpb.DataScanJob, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*DataScanJobIterator) PageInfo ¶ added in v1.5.0
func (it *DataScanJobIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type DataTaxonomyCallOptions ¶ added in v1.9.0
type DataTaxonomyCallOptions struct { CreateDataTaxonomy []gax.CallOption UpdateDataTaxonomy []gax.CallOption DeleteDataTaxonomy []gax.CallOption ListDataTaxonomies []gax.CallOption GetDataTaxonomy []gax.CallOption CreateDataAttributeBinding []gax.CallOption UpdateDataAttributeBinding []gax.CallOption DeleteDataAttributeBinding []gax.CallOption ListDataAttributeBindings []gax.CallOption GetDataAttributeBinding []gax.CallOption CreateDataAttribute []gax.CallOption UpdateDataAttribute []gax.CallOption DeleteDataAttribute []gax.CallOption ListDataAttributes []gax.CallOption GetDataAttribute []gax.CallOption GetLocation []gax.CallOption ListLocations []gax.CallOption CancelOperation []gax.CallOption DeleteOperation []gax.CallOption GetOperation []gax.CallOption ListOperations []gax.CallOption }
DataTaxonomyCallOptions contains the retry settings for each method of DataTaxonomyClient.
type DataTaxonomyClient ¶ added in v1.9.0
type DataTaxonomyClient struct { // The call options for this service. CallOptions *DataTaxonomyCallOptions // LROClient is used internally to handle long-running operations. // It is exposed so that its CallOptions can be modified if required. // Users should not Close this client. LROClient *lroauto.OperationsClient // contains filtered or unexported fields }
DataTaxonomyClient is a client for interacting with Cloud Dataplex API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
DataTaxonomyService enables attribute-based governance. The resources currently offered include DataTaxonomy and DataAttribute.
func NewDataTaxonomyClient ¶ added in v1.9.0
func NewDataTaxonomyClient(ctx context.Context, opts ...option.ClientOption) (*DataTaxonomyClient, error)
NewDataTaxonomyClient creates a new data taxonomy service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
DataTaxonomyService enables attribute-based governance. The resources currently offered include DataTaxonomy and DataAttribute.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*DataTaxonomyClient) CancelOperation ¶ added in v1.9.0
func (c *DataTaxonomyClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*DataTaxonomyClient) Close ¶ added in v1.9.0
func (c *DataTaxonomyClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*DataTaxonomyClient) Connection
deprecated
added in
v1.9.0
func (c *DataTaxonomyClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*DataTaxonomyClient) CreateDataAttribute ¶ added in v1.9.0
func (c *DataTaxonomyClient) CreateDataAttribute(ctx context.Context, req *dataplexpb.CreateDataAttributeRequest, opts ...gax.CallOption) (*CreateDataAttributeOperation, error)
CreateDataAttribute create a DataAttribute resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreateDataAttributeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateDataAttributeRequest. } op, err := c.CreateDataAttribute(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataTaxonomyClient) CreateDataAttributeBinding ¶ added in v1.9.0
func (c *DataTaxonomyClient) CreateDataAttributeBinding(ctx context.Context, req *dataplexpb.CreateDataAttributeBindingRequest, opts ...gax.CallOption) (*CreateDataAttributeBindingOperation, error)
CreateDataAttributeBinding create a DataAttributeBinding resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreateDataAttributeBindingRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateDataAttributeBindingRequest. } op, err := c.CreateDataAttributeBinding(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataTaxonomyClient) CreateDataAttributeBindingOperation ¶ added in v1.9.0
func (c *DataTaxonomyClient) CreateDataAttributeBindingOperation(name string) *CreateDataAttributeBindingOperation
CreateDataAttributeBindingOperation returns a new CreateDataAttributeBindingOperation from a given name. The name must be that of a previously created CreateDataAttributeBindingOperation, possibly from a different process.
func (*DataTaxonomyClient) CreateDataAttributeOperation ¶ added in v1.9.0
func (c *DataTaxonomyClient) CreateDataAttributeOperation(name string) *CreateDataAttributeOperation
CreateDataAttributeOperation returns a new CreateDataAttributeOperation from a given name. The name must be that of a previously created CreateDataAttributeOperation, possibly from a different process.
func (*DataTaxonomyClient) CreateDataTaxonomy ¶ added in v1.9.0
func (c *DataTaxonomyClient) CreateDataTaxonomy(ctx context.Context, req *dataplexpb.CreateDataTaxonomyRequest, opts ...gax.CallOption) (*CreateDataTaxonomyOperation, error)
CreateDataTaxonomy create a DataTaxonomy resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreateDataTaxonomyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateDataTaxonomyRequest. } op, err := c.CreateDataTaxonomy(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataTaxonomyClient) CreateDataTaxonomyOperation ¶ added in v1.9.0
func (c *DataTaxonomyClient) CreateDataTaxonomyOperation(name string) *CreateDataTaxonomyOperation
CreateDataTaxonomyOperation returns a new CreateDataTaxonomyOperation from a given name. The name must be that of a previously created CreateDataTaxonomyOperation, possibly from a different process.
func (*DataTaxonomyClient) DeleteDataAttribute ¶ added in v1.9.0
func (c *DataTaxonomyClient) DeleteDataAttribute(ctx context.Context, req *dataplexpb.DeleteDataAttributeRequest, opts ...gax.CallOption) (*DeleteDataAttributeOperation, error)
DeleteDataAttribute deletes a Data Attribute resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeleteDataAttributeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteDataAttributeRequest. } op, err := c.DeleteDataAttribute(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*DataTaxonomyClient) DeleteDataAttributeBinding ¶ added in v1.9.0
func (c *DataTaxonomyClient) DeleteDataAttributeBinding(ctx context.Context, req *dataplexpb.DeleteDataAttributeBindingRequest, opts ...gax.CallOption) (*DeleteDataAttributeBindingOperation, error)
DeleteDataAttributeBinding deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeleteDataAttributeBindingRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteDataAttributeBindingRequest. } op, err := c.DeleteDataAttributeBinding(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*DataTaxonomyClient) DeleteDataAttributeBindingOperation ¶ added in v1.9.0
func (c *DataTaxonomyClient) DeleteDataAttributeBindingOperation(name string) *DeleteDataAttributeBindingOperation
DeleteDataAttributeBindingOperation returns a new DeleteDataAttributeBindingOperation from a given name. The name must be that of a previously created DeleteDataAttributeBindingOperation, possibly from a different process.
func (*DataTaxonomyClient) DeleteDataAttributeOperation ¶ added in v1.9.0
func (c *DataTaxonomyClient) DeleteDataAttributeOperation(name string) *DeleteDataAttributeOperation
DeleteDataAttributeOperation returns a new DeleteDataAttributeOperation from a given name. The name must be that of a previously created DeleteDataAttributeOperation, possibly from a different process.
func (*DataTaxonomyClient) DeleteDataTaxonomy ¶ added in v1.9.0
func (c *DataTaxonomyClient) DeleteDataTaxonomy(ctx context.Context, req *dataplexpb.DeleteDataTaxonomyRequest, opts ...gax.CallOption) (*DeleteDataTaxonomyOperation, error)
DeleteDataTaxonomy deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeleteDataTaxonomyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteDataTaxonomyRequest. } op, err := c.DeleteDataTaxonomy(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*DataTaxonomyClient) DeleteDataTaxonomyOperation ¶ added in v1.9.0
func (c *DataTaxonomyClient) DeleteDataTaxonomyOperation(name string) *DeleteDataTaxonomyOperation
DeleteDataTaxonomyOperation returns a new DeleteDataTaxonomyOperation from a given name. The name must be that of a previously created DeleteDataTaxonomyOperation, possibly from a different process.
func (*DataTaxonomyClient) DeleteOperation ¶ added in v1.9.0
func (c *DataTaxonomyClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.DeleteOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest. } err = c.DeleteOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*DataTaxonomyClient) GetDataAttribute ¶ added in v1.9.0
func (c *DataTaxonomyClient) GetDataAttribute(ctx context.Context, req *dataplexpb.GetDataAttributeRequest, opts ...gax.CallOption) (*dataplexpb.DataAttribute, error)
GetDataAttribute retrieves a Data Attribute resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetDataAttributeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetDataAttributeRequest. } resp, err := c.GetDataAttribute(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataTaxonomyClient) GetDataAttributeBinding ¶ added in v1.9.0
func (c *DataTaxonomyClient) GetDataAttributeBinding(ctx context.Context, req *dataplexpb.GetDataAttributeBindingRequest, opts ...gax.CallOption) (*dataplexpb.DataAttributeBinding, error)
GetDataAttributeBinding retrieves a DataAttributeBinding resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetDataAttributeBindingRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetDataAttributeBindingRequest. } resp, err := c.GetDataAttributeBinding(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataTaxonomyClient) GetDataTaxonomy ¶ added in v1.9.0
func (c *DataTaxonomyClient) GetDataTaxonomy(ctx context.Context, req *dataplexpb.GetDataTaxonomyRequest, opts ...gax.CallOption) (*dataplexpb.DataTaxonomy, error)
GetDataTaxonomy retrieves a DataTaxonomy resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetDataTaxonomyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetDataTaxonomyRequest. } resp, err := c.GetDataTaxonomy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataTaxonomyClient) GetLocation ¶ added in v1.9.0
func (c *DataTaxonomyClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.GetLocationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest. } resp, err := c.GetLocation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataTaxonomyClient) GetOperation ¶ added in v1.9.0
func (c *DataTaxonomyClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.GetOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest. } resp, err := c.GetOperation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataTaxonomyClient) ListDataAttributeBindings ¶ added in v1.9.0
func (c *DataTaxonomyClient) ListDataAttributeBindings(ctx context.Context, req *dataplexpb.ListDataAttributeBindingsRequest, opts ...gax.CallOption) *DataAttributeBindingIterator
ListDataAttributeBindings lists DataAttributeBinding resources in a project and location.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListDataAttributeBindingsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListDataAttributeBindingsRequest. } it := c.ListDataAttributeBindings(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataTaxonomyClient) ListDataAttributes ¶ added in v1.9.0
func (c *DataTaxonomyClient) ListDataAttributes(ctx context.Context, req *dataplexpb.ListDataAttributesRequest, opts ...gax.CallOption) *DataAttributeIterator
ListDataAttributes lists Data Attribute resources in a DataTaxonomy.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListDataAttributesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListDataAttributesRequest. } it := c.ListDataAttributes(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataTaxonomyClient) ListDataTaxonomies ¶ added in v1.9.0
func (c *DataTaxonomyClient) ListDataTaxonomies(ctx context.Context, req *dataplexpb.ListDataTaxonomiesRequest, opts ...gax.CallOption) *DataTaxonomyIterator
ListDataTaxonomies lists DataTaxonomy resources in a project and location.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListDataTaxonomiesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListDataTaxonomiesRequest. } it := c.ListDataTaxonomies(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataTaxonomyClient) ListLocations ¶ added in v1.9.0
func (c *DataTaxonomyClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
ListLocations lists information about the supported locations for this service.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" "google.golang.org/api/iterator" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } it := c.ListLocations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataTaxonomyClient) ListOperations ¶ added in v1.9.0
func (c *DataTaxonomyClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } it := c.ListOperations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataTaxonomyClient) UpdateDataAttribute ¶ added in v1.9.0
func (c *DataTaxonomyClient) UpdateDataAttribute(ctx context.Context, req *dataplexpb.UpdateDataAttributeRequest, opts ...gax.CallOption) (*UpdateDataAttributeOperation, error)
UpdateDataAttribute updates a DataAttribute resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.UpdateDataAttributeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateDataAttributeRequest. } op, err := c.UpdateDataAttribute(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataTaxonomyClient) UpdateDataAttributeBinding ¶ added in v1.9.0
func (c *DataTaxonomyClient) UpdateDataAttributeBinding(ctx context.Context, req *dataplexpb.UpdateDataAttributeBindingRequest, opts ...gax.CallOption) (*UpdateDataAttributeBindingOperation, error)
UpdateDataAttributeBinding updates a DataAttributeBinding resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.UpdateDataAttributeBindingRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateDataAttributeBindingRequest. } op, err := c.UpdateDataAttributeBinding(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataTaxonomyClient) UpdateDataAttributeBindingOperation ¶ added in v1.9.0
func (c *DataTaxonomyClient) UpdateDataAttributeBindingOperation(name string) *UpdateDataAttributeBindingOperation
UpdateDataAttributeBindingOperation returns a new UpdateDataAttributeBindingOperation from a given name. The name must be that of a previously created UpdateDataAttributeBindingOperation, possibly from a different process.
func (*DataTaxonomyClient) UpdateDataAttributeOperation ¶ added in v1.9.0
func (c *DataTaxonomyClient) UpdateDataAttributeOperation(name string) *UpdateDataAttributeOperation
UpdateDataAttributeOperation returns a new UpdateDataAttributeOperation from a given name. The name must be that of a previously created UpdateDataAttributeOperation, possibly from a different process.
func (*DataTaxonomyClient) UpdateDataTaxonomy ¶ added in v1.9.0
func (c *DataTaxonomyClient) UpdateDataTaxonomy(ctx context.Context, req *dataplexpb.UpdateDataTaxonomyRequest, opts ...gax.CallOption) (*UpdateDataTaxonomyOperation, error)
UpdateDataTaxonomy updates a DataTaxonomy resource.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewDataTaxonomyClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.UpdateDataTaxonomyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateDataTaxonomyRequest. } op, err := c.UpdateDataTaxonomy(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataTaxonomyClient) UpdateDataTaxonomyOperation ¶ added in v1.9.0
func (c *DataTaxonomyClient) UpdateDataTaxonomyOperation(name string) *UpdateDataTaxonomyOperation
UpdateDataTaxonomyOperation returns a new UpdateDataTaxonomyOperation from a given name. The name must be that of a previously created UpdateDataTaxonomyOperation, possibly from a different process.
type DataTaxonomyIterator ¶ added in v1.9.0
type DataTaxonomyIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.DataTaxonomy, nextPageToken string, err error) // contains filtered or unexported fields }
DataTaxonomyIterator manages a stream of *dataplexpb.DataTaxonomy.
func (*DataTaxonomyIterator) Next ¶ added in v1.9.0
func (it *DataTaxonomyIterator) Next() (*dataplexpb.DataTaxonomy, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*DataTaxonomyIterator) PageInfo ¶ added in v1.9.0
func (it *DataTaxonomyIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type DeleteAspectTypeOperation ¶ added in v1.15.0
type DeleteAspectTypeOperation struct {
// contains filtered or unexported fields
}
DeleteAspectTypeOperation manages a long-running operation from DeleteAspectType.
func (*DeleteAspectTypeOperation) Done ¶ added in v1.15.0
func (op *DeleteAspectTypeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteAspectTypeOperation) Metadata ¶ added in v1.15.0
func (op *DeleteAspectTypeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteAspectTypeOperation) Name ¶ added in v1.15.0
func (op *DeleteAspectTypeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteAspectTypeOperation) Poll ¶ added in v1.15.0
func (op *DeleteAspectTypeOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteAspectTypeOperation) Wait ¶ added in v1.15.0
func (op *DeleteAspectTypeOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeleteAssetOperation ¶
type DeleteAssetOperation struct {
// contains filtered or unexported fields
}
DeleteAssetOperation manages a long-running operation from DeleteAsset.
func (*DeleteAssetOperation) Done ¶
func (op *DeleteAssetOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteAssetOperation) Metadata ¶
func (op *DeleteAssetOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteAssetOperation) Name ¶
func (op *DeleteAssetOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteAssetOperation) Poll ¶
func (op *DeleteAssetOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteAssetOperation) Wait ¶
func (op *DeleteAssetOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeleteDataAttributeBindingOperation ¶ added in v1.9.0
type DeleteDataAttributeBindingOperation struct {
// contains filtered or unexported fields
}
DeleteDataAttributeBindingOperation manages a long-running operation from DeleteDataAttributeBinding.
func (*DeleteDataAttributeBindingOperation) Done ¶ added in v1.9.0
func (op *DeleteDataAttributeBindingOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteDataAttributeBindingOperation) Metadata ¶ added in v1.9.0
func (op *DeleteDataAttributeBindingOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteDataAttributeBindingOperation) Name ¶ added in v1.9.0
func (op *DeleteDataAttributeBindingOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteDataAttributeBindingOperation) Poll ¶ added in v1.9.0
func (op *DeleteDataAttributeBindingOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteDataAttributeBindingOperation) Wait ¶ added in v1.9.0
func (op *DeleteDataAttributeBindingOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeleteDataAttributeOperation ¶ added in v1.9.0
type DeleteDataAttributeOperation struct {
// contains filtered or unexported fields
}
DeleteDataAttributeOperation manages a long-running operation from DeleteDataAttribute.
func (*DeleteDataAttributeOperation) Done ¶ added in v1.9.0
func (op *DeleteDataAttributeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteDataAttributeOperation) Metadata ¶ added in v1.9.0
func (op *DeleteDataAttributeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteDataAttributeOperation) Name ¶ added in v1.9.0
func (op *DeleteDataAttributeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteDataAttributeOperation) Poll ¶ added in v1.9.0
func (op *DeleteDataAttributeOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteDataAttributeOperation) Wait ¶ added in v1.9.0
func (op *DeleteDataAttributeOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeleteDataScanOperation ¶ added in v1.5.0
type DeleteDataScanOperation struct {
// contains filtered or unexported fields
}
DeleteDataScanOperation manages a long-running operation from DeleteDataScan.
func (*DeleteDataScanOperation) Done ¶ added in v1.5.0
func (op *DeleteDataScanOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteDataScanOperation) Metadata ¶ added in v1.5.0
func (op *DeleteDataScanOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteDataScanOperation) Name ¶ added in v1.5.0
func (op *DeleteDataScanOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteDataScanOperation) Poll ¶ added in v1.5.0
func (op *DeleteDataScanOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteDataScanOperation) Wait ¶ added in v1.5.0
func (op *DeleteDataScanOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeleteDataTaxonomyOperation ¶ added in v1.9.0
type DeleteDataTaxonomyOperation struct {
// contains filtered or unexported fields
}
DeleteDataTaxonomyOperation manages a long-running operation from DeleteDataTaxonomy.
func (*DeleteDataTaxonomyOperation) Done ¶ added in v1.9.0
func (op *DeleteDataTaxonomyOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteDataTaxonomyOperation) Metadata ¶ added in v1.9.0
func (op *DeleteDataTaxonomyOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteDataTaxonomyOperation) Name ¶ added in v1.9.0
func (op *DeleteDataTaxonomyOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteDataTaxonomyOperation) Poll ¶ added in v1.9.0
func (op *DeleteDataTaxonomyOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteDataTaxonomyOperation) Wait ¶ added in v1.9.0
func (op *DeleteDataTaxonomyOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeleteEntryGroupOperation ¶ added in v1.15.0
type DeleteEntryGroupOperation struct {
// contains filtered or unexported fields
}
DeleteEntryGroupOperation manages a long-running operation from DeleteEntryGroup.
func (*DeleteEntryGroupOperation) Done ¶ added in v1.15.0
func (op *DeleteEntryGroupOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteEntryGroupOperation) Metadata ¶ added in v1.15.0
func (op *DeleteEntryGroupOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteEntryGroupOperation) Name ¶ added in v1.15.0
func (op *DeleteEntryGroupOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteEntryGroupOperation) Poll ¶ added in v1.15.0
func (op *DeleteEntryGroupOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteEntryGroupOperation) Wait ¶ added in v1.15.0
func (op *DeleteEntryGroupOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeleteEntryTypeOperation ¶ added in v1.15.0
type DeleteEntryTypeOperation struct {
// contains filtered or unexported fields
}
DeleteEntryTypeOperation manages a long-running operation from DeleteEntryType.
func (*DeleteEntryTypeOperation) Done ¶ added in v1.15.0
func (op *DeleteEntryTypeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteEntryTypeOperation) Metadata ¶ added in v1.15.0
func (op *DeleteEntryTypeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteEntryTypeOperation) Name ¶ added in v1.15.0
func (op *DeleteEntryTypeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteEntryTypeOperation) Poll ¶ added in v1.15.0
func (op *DeleteEntryTypeOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteEntryTypeOperation) Wait ¶ added in v1.15.0
func (op *DeleteEntryTypeOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeleteEnvironmentOperation ¶ added in v0.3.0
type DeleteEnvironmentOperation struct {
// contains filtered or unexported fields
}
DeleteEnvironmentOperation manages a long-running operation from DeleteEnvironment.
func (*DeleteEnvironmentOperation) Done ¶ added in v0.3.0
func (op *DeleteEnvironmentOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteEnvironmentOperation) Metadata ¶ added in v0.3.0
func (op *DeleteEnvironmentOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteEnvironmentOperation) Name ¶ added in v0.3.0
func (op *DeleteEnvironmentOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteEnvironmentOperation) Poll ¶ added in v0.3.0
func (op *DeleteEnvironmentOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteEnvironmentOperation) Wait ¶ added in v0.3.0
func (op *DeleteEnvironmentOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeleteLakeOperation ¶
type DeleteLakeOperation struct {
// contains filtered or unexported fields
}
DeleteLakeOperation manages a long-running operation from DeleteLake.
func (*DeleteLakeOperation) Done ¶
func (op *DeleteLakeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteLakeOperation) Metadata ¶
func (op *DeleteLakeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteLakeOperation) Name ¶
func (op *DeleteLakeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteLakeOperation) Poll ¶
func (op *DeleteLakeOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteLakeOperation) Wait ¶
func (op *DeleteLakeOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeleteTaskOperation ¶
type DeleteTaskOperation struct {
// contains filtered or unexported fields
}
DeleteTaskOperation manages a long-running operation from DeleteTask.
func (*DeleteTaskOperation) Done ¶
func (op *DeleteTaskOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteTaskOperation) Metadata ¶
func (op *DeleteTaskOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteTaskOperation) Name ¶
func (op *DeleteTaskOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteTaskOperation) Poll ¶
func (op *DeleteTaskOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteTaskOperation) Wait ¶
func (op *DeleteTaskOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeleteZoneOperation ¶
type DeleteZoneOperation struct {
// contains filtered or unexported fields
}
DeleteZoneOperation manages a long-running operation from DeleteZone.
func (*DeleteZoneOperation) Done ¶
func (op *DeleteZoneOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteZoneOperation) Metadata ¶
func (op *DeleteZoneOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteZoneOperation) Name ¶
func (op *DeleteZoneOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteZoneOperation) Poll ¶
func (op *DeleteZoneOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteZoneOperation) Wait ¶
func (op *DeleteZoneOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type EntityIterator ¶
type EntityIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.Entity, nextPageToken string, err error) // contains filtered or unexported fields }
EntityIterator manages a stream of *dataplexpb.Entity.
func (*EntityIterator) Next ¶
func (it *EntityIterator) Next() (*dataplexpb.Entity, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*EntityIterator) PageInfo ¶
func (it *EntityIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type EntryGroupIterator ¶ added in v1.15.0
type EntryGroupIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.EntryGroup, nextPageToken string, err error) // contains filtered or unexported fields }
EntryGroupIterator manages a stream of *dataplexpb.EntryGroup.
func (*EntryGroupIterator) Next ¶ added in v1.15.0
func (it *EntryGroupIterator) Next() (*dataplexpb.EntryGroup, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*EntryGroupIterator) PageInfo ¶ added in v1.15.0
func (it *EntryGroupIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type EntryIterator ¶ added in v1.15.0
type EntryIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.Entry, nextPageToken string, err error) // contains filtered or unexported fields }
EntryIterator manages a stream of *dataplexpb.Entry.
func (*EntryIterator) Next ¶ added in v1.15.0
func (it *EntryIterator) Next() (*dataplexpb.Entry, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*EntryIterator) PageInfo ¶ added in v1.15.0
func (it *EntryIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type EntryTypeIterator ¶ added in v1.15.0
type EntryTypeIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.EntryType, nextPageToken string, err error) // contains filtered or unexported fields }
EntryTypeIterator manages a stream of *dataplexpb.EntryType.
func (*EntryTypeIterator) Next ¶ added in v1.15.0
func (it *EntryTypeIterator) Next() (*dataplexpb.EntryType, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*EntryTypeIterator) PageInfo ¶ added in v1.15.0
func (it *EntryTypeIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type EnvironmentIterator ¶ added in v0.3.0
type EnvironmentIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.Environment, nextPageToken string, err error) // contains filtered or unexported fields }
EnvironmentIterator manages a stream of *dataplexpb.Environment.
func (*EnvironmentIterator) Next ¶ added in v0.3.0
func (it *EnvironmentIterator) Next() (*dataplexpb.Environment, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*EnvironmentIterator) PageInfo ¶ added in v0.3.0
func (it *EnvironmentIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type JobIterator ¶
type JobIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.Job, nextPageToken string, err error) // contains filtered or unexported fields }
JobIterator manages a stream of *dataplexpb.Job.
func (*JobIterator) Next ¶
func (it *JobIterator) Next() (*dataplexpb.Job, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*JobIterator) PageInfo ¶
func (it *JobIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type LakeIterator ¶
type LakeIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.Lake, nextPageToken string, err error) // contains filtered or unexported fields }
LakeIterator manages a stream of *dataplexpb.Lake.
func (*LakeIterator) Next ¶
func (it *LakeIterator) Next() (*dataplexpb.Lake, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*LakeIterator) PageInfo ¶
func (it *LakeIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type LocationIterator ¶ added in v1.1.0
type LocationIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*locationpb.Location, nextPageToken string, err error) // contains filtered or unexported fields }
LocationIterator manages a stream of *locationpb.Location.
func (*LocationIterator) Next ¶ added in v1.1.0
func (it *LocationIterator) Next() (*locationpb.Location, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*LocationIterator) PageInfo ¶ added in v1.1.0
func (it *LocationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type MetadataCallOptions ¶
type MetadataCallOptions struct { CreateEntity []gax.CallOption UpdateEntity []gax.CallOption DeleteEntity []gax.CallOption GetEntity []gax.CallOption ListEntities []gax.CallOption CreatePartition []gax.CallOption DeletePartition []gax.CallOption GetPartition []gax.CallOption ListPartitions []gax.CallOption GetLocation []gax.CallOption ListLocations []gax.CallOption CancelOperation []gax.CallOption DeleteOperation []gax.CallOption GetOperation []gax.CallOption ListOperations []gax.CallOption }
MetadataCallOptions contains the retry settings for each method of MetadataClient.
type MetadataClient ¶
type MetadataClient struct { // The call options for this service. CallOptions *MetadataCallOptions // contains filtered or unexported fields }
MetadataClient is a client for interacting with Cloud Dataplex API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Metadata service manages metadata resources such as tables, filesets and partitions.
func NewMetadataClient ¶
func NewMetadataClient(ctx context.Context, opts ...option.ClientOption) (*MetadataClient, error)
NewMetadataClient creates a new metadata service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Metadata service manages metadata resources such as tables, filesets and partitions.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*MetadataClient) CancelOperation ¶ added in v1.1.0
func (c *MetadataClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*MetadataClient) Close ¶
func (c *MetadataClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*MetadataClient) Connection
deprecated
func (c *MetadataClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*MetadataClient) CreateEntity ¶ added in v0.3.0
func (c *MetadataClient) CreateEntity(ctx context.Context, req *dataplexpb.CreateEntityRequest, opts ...gax.CallOption) (*dataplexpb.Entity, error)
CreateEntity create a metadata entity.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreateEntityRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateEntityRequest. } resp, err := c.CreateEntity(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*MetadataClient) CreatePartition ¶ added in v0.3.0
func (c *MetadataClient) CreatePartition(ctx context.Context, req *dataplexpb.CreatePartitionRequest, opts ...gax.CallOption) (*dataplexpb.Partition, error)
CreatePartition create a metadata partition.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.CreatePartitionRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreatePartitionRequest. } resp, err := c.CreatePartition(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*MetadataClient) DeleteEntity ¶ added in v0.3.0
func (c *MetadataClient) DeleteEntity(ctx context.Context, req *dataplexpb.DeleteEntityRequest, opts ...gax.CallOption) error
DeleteEntity delete a metadata entity.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeleteEntityRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteEntityRequest. } err = c.DeleteEntity(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*MetadataClient) DeleteOperation ¶ added in v1.1.0
func (c *MetadataClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.DeleteOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest. } err = c.DeleteOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*MetadataClient) DeletePartition ¶ added in v0.3.0
func (c *MetadataClient) DeletePartition(ctx context.Context, req *dataplexpb.DeletePartitionRequest, opts ...gax.CallOption) error
DeletePartition delete a metadata partition.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.DeletePartitionRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeletePartitionRequest. } err = c.DeletePartition(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*MetadataClient) GetEntity ¶
func (c *MetadataClient) GetEntity(ctx context.Context, req *dataplexpb.GetEntityRequest, opts ...gax.CallOption) (*dataplexpb.Entity, error)
GetEntity get a metadata entity.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetEntityRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetEntityRequest. } resp, err := c.GetEntity(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*MetadataClient) GetLocation ¶ added in v1.1.0
func (c *MetadataClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.GetLocationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest. } resp, err := c.GetLocation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*MetadataClient) GetOperation ¶ added in v1.1.0
func (c *MetadataClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.GetOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest. } resp, err := c.GetOperation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*MetadataClient) GetPartition ¶
func (c *MetadataClient) GetPartition(ctx context.Context, req *dataplexpb.GetPartitionRequest, opts ...gax.CallOption) (*dataplexpb.Partition, error)
GetPartition get a metadata partition of an entity.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.GetPartitionRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#GetPartitionRequest. } resp, err := c.GetPartition(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*MetadataClient) ListEntities ¶
func (c *MetadataClient) ListEntities(ctx context.Context, req *dataplexpb.ListEntitiesRequest, opts ...gax.CallOption) *EntityIterator
ListEntities list metadata entities in a zone.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListEntitiesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListEntitiesRequest. } it := c.ListEntities(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*MetadataClient) ListLocations ¶ added in v1.1.0
func (c *MetadataClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
ListLocations lists information about the supported locations for this service.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" "google.golang.org/api/iterator" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } it := c.ListLocations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*MetadataClient) ListOperations ¶ added in v1.1.0
func (c *MetadataClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } it := c.ListOperations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*MetadataClient) ListPartitions ¶
func (c *MetadataClient) ListPartitions(ctx context.Context, req *dataplexpb.ListPartitionsRequest, opts ...gax.CallOption) *PartitionIterator
ListPartitions list metadata partitions of an entity.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.ListPartitionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListPartitionsRequest. } it := c.ListPartitions(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*MetadataClient) UpdateEntity ¶ added in v0.3.0
func (c *MetadataClient) UpdateEntity(ctx context.Context, req *dataplexpb.UpdateEntityRequest, opts ...gax.CallOption) (*dataplexpb.Entity, error)
UpdateEntity update a metadata entity. Only supports full resource update.
Example ¶
package main import ( "context" dataplex "cloud.google.com/go/dataplex/apiv1" dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := dataplex.NewMetadataClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &dataplexpb.UpdateEntityRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#UpdateEntityRequest. } resp, err := c.UpdateEntity(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
type OperationIterator ¶ added in v1.1.0
type OperationIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*longrunningpb.Operation, nextPageToken string, err error) // contains filtered or unexported fields }
OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) Next ¶ added in v1.1.0
func (it *OperationIterator) Next() (*longrunningpb.Operation, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*OperationIterator) PageInfo ¶ added in v1.1.0
func (it *OperationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type PartitionIterator ¶
type PartitionIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.Partition, nextPageToken string, err error) // contains filtered or unexported fields }
PartitionIterator manages a stream of *dataplexpb.Partition.
func (*PartitionIterator) Next ¶
func (it *PartitionIterator) Next() (*dataplexpb.Partition, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*PartitionIterator) PageInfo ¶
func (it *PartitionIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type SearchEntriesResultIterator ¶ added in v1.15.0
type SearchEntriesResultIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.SearchEntriesResult, nextPageToken string, err error) // contains filtered or unexported fields }
SearchEntriesResultIterator manages a stream of *dataplexpb.SearchEntriesResult.
func (*SearchEntriesResultIterator) Next ¶ added in v1.15.0
func (it *SearchEntriesResultIterator) Next() (*dataplexpb.SearchEntriesResult, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*SearchEntriesResultIterator) PageInfo ¶ added in v1.15.0
func (it *SearchEntriesResultIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type SessionIterator ¶ added in v0.3.0
type SessionIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.Session, nextPageToken string, err error) // contains filtered or unexported fields }
SessionIterator manages a stream of *dataplexpb.Session.
func (*SessionIterator) Next ¶ added in v0.3.0
func (it *SessionIterator) Next() (*dataplexpb.Session, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*SessionIterator) PageInfo ¶ added in v0.3.0
func (it *SessionIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type TaskIterator ¶
type TaskIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.Task, nextPageToken string, err error) // contains filtered or unexported fields }
TaskIterator manages a stream of *dataplexpb.Task.
func (*TaskIterator) Next ¶
func (it *TaskIterator) Next() (*dataplexpb.Task, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*TaskIterator) PageInfo ¶
func (it *TaskIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type UpdateAspectTypeOperation ¶ added in v1.15.0
type UpdateAspectTypeOperation struct {
// contains filtered or unexported fields
}
UpdateAspectTypeOperation manages a long-running operation from UpdateAspectType.
func (*UpdateAspectTypeOperation) Done ¶ added in v1.15.0
func (op *UpdateAspectTypeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateAspectTypeOperation) Metadata ¶ added in v1.15.0
func (op *UpdateAspectTypeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateAspectTypeOperation) Name ¶ added in v1.15.0
func (op *UpdateAspectTypeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateAspectTypeOperation) Poll ¶ added in v1.15.0
func (op *UpdateAspectTypeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.AspectType, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateAspectTypeOperation) Wait ¶ added in v1.15.0
func (op *UpdateAspectTypeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.AspectType, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdateAssetOperation ¶
type UpdateAssetOperation struct {
// contains filtered or unexported fields
}
UpdateAssetOperation manages a long-running operation from UpdateAsset.
func (*UpdateAssetOperation) Done ¶
func (op *UpdateAssetOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateAssetOperation) Metadata ¶
func (op *UpdateAssetOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateAssetOperation) Name ¶
func (op *UpdateAssetOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateAssetOperation) Poll ¶
func (op *UpdateAssetOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Asset, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateAssetOperation) Wait ¶
func (op *UpdateAssetOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Asset, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdateDataAttributeBindingOperation ¶ added in v1.9.0
type UpdateDataAttributeBindingOperation struct {
// contains filtered or unexported fields
}
UpdateDataAttributeBindingOperation manages a long-running operation from UpdateDataAttributeBinding.
func (*UpdateDataAttributeBindingOperation) Done ¶ added in v1.9.0
func (op *UpdateDataAttributeBindingOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateDataAttributeBindingOperation) Metadata ¶ added in v1.9.0
func (op *UpdateDataAttributeBindingOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateDataAttributeBindingOperation) Name ¶ added in v1.9.0
func (op *UpdateDataAttributeBindingOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateDataAttributeBindingOperation) Poll ¶ added in v1.9.0
func (op *UpdateDataAttributeBindingOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttributeBinding, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateDataAttributeBindingOperation) Wait ¶ added in v1.9.0
func (op *UpdateDataAttributeBindingOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttributeBinding, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdateDataAttributeOperation ¶ added in v1.9.0
type UpdateDataAttributeOperation struct {
// contains filtered or unexported fields
}
UpdateDataAttributeOperation manages a long-running operation from UpdateDataAttribute.
func (*UpdateDataAttributeOperation) Done ¶ added in v1.9.0
func (op *UpdateDataAttributeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateDataAttributeOperation) Metadata ¶ added in v1.9.0
func (op *UpdateDataAttributeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateDataAttributeOperation) Name ¶ added in v1.9.0
func (op *UpdateDataAttributeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateDataAttributeOperation) Poll ¶ added in v1.9.0
func (op *UpdateDataAttributeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttribute, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateDataAttributeOperation) Wait ¶ added in v1.9.0
func (op *UpdateDataAttributeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataAttribute, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdateDataScanOperation ¶ added in v1.5.0
type UpdateDataScanOperation struct {
// contains filtered or unexported fields
}
UpdateDataScanOperation manages a long-running operation from UpdateDataScan.
func (*UpdateDataScanOperation) Done ¶ added in v1.5.0
func (op *UpdateDataScanOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateDataScanOperation) Metadata ¶ added in v1.5.0
func (op *UpdateDataScanOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateDataScanOperation) Name ¶ added in v1.5.0
func (op *UpdateDataScanOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateDataScanOperation) Poll ¶ added in v1.5.0
func (op *UpdateDataScanOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataScan, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateDataScanOperation) Wait ¶ added in v1.5.0
func (op *UpdateDataScanOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataScan, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdateDataTaxonomyOperation ¶ added in v1.9.0
type UpdateDataTaxonomyOperation struct {
// contains filtered or unexported fields
}
UpdateDataTaxonomyOperation manages a long-running operation from UpdateDataTaxonomy.
func (*UpdateDataTaxonomyOperation) Done ¶ added in v1.9.0
func (op *UpdateDataTaxonomyOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateDataTaxonomyOperation) Metadata ¶ added in v1.9.0
func (op *UpdateDataTaxonomyOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateDataTaxonomyOperation) Name ¶ added in v1.9.0
func (op *UpdateDataTaxonomyOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateDataTaxonomyOperation) Poll ¶ added in v1.9.0
func (op *UpdateDataTaxonomyOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataTaxonomy, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateDataTaxonomyOperation) Wait ¶ added in v1.9.0
func (op *UpdateDataTaxonomyOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.DataTaxonomy, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdateEntryGroupOperation ¶ added in v1.15.0
type UpdateEntryGroupOperation struct {
// contains filtered or unexported fields
}
UpdateEntryGroupOperation manages a long-running operation from UpdateEntryGroup.
func (*UpdateEntryGroupOperation) Done ¶ added in v1.15.0
func (op *UpdateEntryGroupOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateEntryGroupOperation) Metadata ¶ added in v1.15.0
func (op *UpdateEntryGroupOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateEntryGroupOperation) Name ¶ added in v1.15.0
func (op *UpdateEntryGroupOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateEntryGroupOperation) Poll ¶ added in v1.15.0
func (op *UpdateEntryGroupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryGroup, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateEntryGroupOperation) Wait ¶ added in v1.15.0
func (op *UpdateEntryGroupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryGroup, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdateEntryTypeOperation ¶ added in v1.15.0
type UpdateEntryTypeOperation struct {
// contains filtered or unexported fields
}
UpdateEntryTypeOperation manages a long-running operation from UpdateEntryType.
func (*UpdateEntryTypeOperation) Done ¶ added in v1.15.0
func (op *UpdateEntryTypeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateEntryTypeOperation) Metadata ¶ added in v1.15.0
func (op *UpdateEntryTypeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateEntryTypeOperation) Name ¶ added in v1.15.0
func (op *UpdateEntryTypeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateEntryTypeOperation) Poll ¶ added in v1.15.0
func (op *UpdateEntryTypeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryType, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateEntryTypeOperation) Wait ¶ added in v1.15.0
func (op *UpdateEntryTypeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.EntryType, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdateEnvironmentOperation ¶ added in v0.3.0
type UpdateEnvironmentOperation struct {
// contains filtered or unexported fields
}
UpdateEnvironmentOperation manages a long-running operation from UpdateEnvironment.
func (*UpdateEnvironmentOperation) Done ¶ added in v0.3.0
func (op *UpdateEnvironmentOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateEnvironmentOperation) Metadata ¶ added in v0.3.0
func (op *UpdateEnvironmentOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateEnvironmentOperation) Name ¶ added in v0.3.0
func (op *UpdateEnvironmentOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateEnvironmentOperation) Poll ¶ added in v0.3.0
func (op *UpdateEnvironmentOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Environment, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateEnvironmentOperation) Wait ¶ added in v0.3.0
func (op *UpdateEnvironmentOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Environment, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdateLakeOperation ¶
type UpdateLakeOperation struct {
// contains filtered or unexported fields
}
UpdateLakeOperation manages a long-running operation from UpdateLake.
func (*UpdateLakeOperation) Done ¶
func (op *UpdateLakeOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateLakeOperation) Metadata ¶
func (op *UpdateLakeOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateLakeOperation) Name ¶
func (op *UpdateLakeOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateLakeOperation) Poll ¶
func (op *UpdateLakeOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Lake, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateLakeOperation) Wait ¶
func (op *UpdateLakeOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Lake, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdateTaskOperation ¶
type UpdateTaskOperation struct {
// contains filtered or unexported fields
}
UpdateTaskOperation manages a long-running operation from UpdateTask.
func (*UpdateTaskOperation) Done ¶
func (op *UpdateTaskOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateTaskOperation) Metadata ¶
func (op *UpdateTaskOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateTaskOperation) Name ¶
func (op *UpdateTaskOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateTaskOperation) Poll ¶
func (op *UpdateTaskOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Task, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateTaskOperation) Wait ¶
func (op *UpdateTaskOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Task, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdateZoneOperation ¶
type UpdateZoneOperation struct {
// contains filtered or unexported fields
}
UpdateZoneOperation manages a long-running operation from UpdateZone.
func (*UpdateZoneOperation) Done ¶
func (op *UpdateZoneOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateZoneOperation) Metadata ¶
func (op *UpdateZoneOperation) Metadata() (*dataplexpb.OperationMetadata, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateZoneOperation) Name ¶
func (op *UpdateZoneOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateZoneOperation) Poll ¶
func (op *UpdateZoneOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Zone, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateZoneOperation) Wait ¶
func (op *UpdateZoneOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*dataplexpb.Zone, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type ZoneIterator ¶
type ZoneIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*dataplexpb.Zone, nextPageToken string, err error) // contains filtered or unexported fields }
ZoneIterator manages a stream of *dataplexpb.Zone.
func (*ZoneIterator) Next ¶
func (it *ZoneIterator) Next() (*dataplexpb.Zone, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ZoneIterator) PageInfo ¶
func (it *ZoneIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.