...

Source file src/cloud.google.com/go/bigquery/biglake/apiv1alpha1/doc.go

Documentation: cloud.google.com/go/bigquery/biglake/apiv1alpha1

     1  // Copyright 2024 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     https://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Code generated by protoc-gen-go_gapic. DO NOT EDIT.
    16  
    17  // Package biglake is an auto-generated package for the
    18  // BigLake API.
    19  //
    20  // The BigLake API provides access to BigLake Metastore, a serverless, fully
    21  // managed, and highly available metastore for open-source data that can be
    22  // used for querying Apache Iceberg tables in BigQuery.
    23  //
    24  //	NOTE: This package is in beta. It is not stable, and may be subject to changes.
    25  //
    26  // # General documentation
    27  //
    28  // For information that is relevant for all client libraries please reference
    29  // https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this
    30  // page includes:
    31  //
    32  //   - [Authentication and Authorization]
    33  //   - [Timeouts and Cancellation]
    34  //   - [Testing against Client Libraries]
    35  //   - [Debugging Client Libraries]
    36  //   - [Inspecting errors]
    37  //
    38  // # Example usage
    39  //
    40  // To get started with this package, create a client.
    41  //
    42  //	ctx := context.Background()
    43  //	// This snippet has been automatically generated and should be regarded as a code template only.
    44  //	// It will require modifications to work:
    45  //	// - It may require correct/in-range values for request initialization.
    46  //	// - It may require specifying regional endpoints when creating the service client as shown in:
    47  //	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
    48  //	c, err := biglake.NewMetastoreClient(ctx)
    49  //	if err != nil {
    50  //		// TODO: Handle error.
    51  //	}
    52  //	defer c.Close()
    53  //
    54  // The client will use your default application credentials. Clients should be reused instead of created as needed.
    55  // The methods of Client are safe for concurrent use by multiple goroutines.
    56  // The returned client must be Closed when it is done being used.
    57  //
    58  // # Using the Client
    59  //
    60  // The following is an example of making an API call with the newly created client.
    61  //
    62  //	ctx := context.Background()
    63  //	// This snippet has been automatically generated and should be regarded as a code template only.
    64  //	// It will require modifications to work:
    65  //	// - It may require correct/in-range values for request initialization.
    66  //	// - It may require specifying regional endpoints when creating the service client as shown in:
    67  //	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
    68  //	c, err := biglake.NewMetastoreClient(ctx)
    69  //	if err != nil {
    70  //		// TODO: Handle error.
    71  //	}
    72  //	defer c.Close()
    73  //
    74  //	req := &biglakepb.CheckLockRequest{
    75  //		// TODO: Fill request struct fields.
    76  //		// See https://pkg.go.dev/cloud.google.com/go/bigquery/biglake/apiv1alpha1/biglakepb#CheckLockRequest.
    77  //	}
    78  //	resp, err := c.CheckLock(ctx, req)
    79  //	if err != nil {
    80  //		// TODO: Handle error.
    81  //	}
    82  //	// TODO: Use resp.
    83  //	_ = resp
    84  //
    85  // # Use of Context
    86  //
    87  // The ctx passed to NewMetastoreClient is used for authentication requests and
    88  // for creating the underlying connection, but is not used for subsequent calls.
    89  // Individual methods on the client use the ctx given to them.
    90  //
    91  // To close the open connection, use the Close() method.
    92  //
    93  // [Authentication and Authorization]: https://pkg.go.dev/cloud.google.com/go#hdr-Authentication_and_Authorization
    94  // [Timeouts and Cancellation]: https://pkg.go.dev/cloud.google.com/go#hdr-Timeouts_and_Cancellation
    95  // [Testing against Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Testing
    96  // [Debugging Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Debugging
    97  // [Inspecting errors]: https://pkg.go.dev/cloud.google.com/go#hdr-Inspecting_errors
    98  package biglake // import "cloud.google.com/go/bigquery/biglake/apiv1alpha1"
    99  
   100  import (
   101  	"context"
   102  
   103  	"google.golang.org/api/option"
   104  )
   105  
   106  // For more information on implementing a client constructor hook, see
   107  // https://github.com/googleapis/google-cloud-go/wiki/Customizing-constructors.
   108  type clientHookParams struct{}
   109  type clientHook func(context.Context, clientHookParams) ([]option.ClientOption, error)
   110  
   111  var versionClient string
   112  
   113  func getVersionClient() string {
   114  	if versionClient == "" {
   115  		return "UNKNOWN"
   116  	}
   117  	return versionClient
   118  }
   119  
   120  // DefaultAuthScopes reports the default set of authentication scopes to use with this package.
   121  func DefaultAuthScopes() []string {
   122  	return []string{
   123  		"https://www.googleapis.com/auth/bigquery",
   124  		"https://www.googleapis.com/auth/cloud-platform",
   125  	}
   126  }
   127  

View as plain text