...

Source file src/cloud.google.com/go/bigquery/storage/apiv1/doc.go

Documentation: cloud.google.com/go/bigquery/storage/apiv1

     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 storage is an auto-generated package for the
    18  // BigQuery Storage API.
    19  //
    20  // # General documentation
    21  //
    22  // For information that is relevant for all client libraries please reference
    23  // https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this
    24  // page includes:
    25  //
    26  //   - [Authentication and Authorization]
    27  //   - [Timeouts and Cancellation]
    28  //   - [Testing against Client Libraries]
    29  //   - [Debugging Client Libraries]
    30  //   - [Inspecting errors]
    31  //
    32  // # Example usage
    33  //
    34  // To get started with this package, create a client.
    35  //
    36  //	ctx := context.Background()
    37  //	// This snippet has been automatically generated and should be regarded as a code template only.
    38  //	// It will require modifications to work:
    39  //	// - It may require correct/in-range values for request initialization.
    40  //	// - It may require specifying regional endpoints when creating the service client as shown in:
    41  //	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
    42  //	c, err := storage.NewBigQueryReadClient(ctx)
    43  //	if err != nil {
    44  //		// TODO: Handle error.
    45  //	}
    46  //	defer c.Close()
    47  //
    48  // The client will use your default application credentials. Clients should be reused instead of created as needed.
    49  // The methods of Client are safe for concurrent use by multiple goroutines.
    50  // The returned client must be Closed when it is done being used.
    51  //
    52  // # Using the Client
    53  //
    54  // The following is an example of making an API call with the newly created client.
    55  //
    56  //	ctx := context.Background()
    57  //	// This snippet has been automatically generated and should be regarded as a code template only.
    58  //	// It will require modifications to work:
    59  //	// - It may require correct/in-range values for request initialization.
    60  //	// - It may require specifying regional endpoints when creating the service client as shown in:
    61  //	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
    62  //	c, err := storage.NewBigQueryReadClient(ctx)
    63  //	if err != nil {
    64  //		// TODO: Handle error.
    65  //	}
    66  //	defer c.Close()
    67  //
    68  //	req := &storagepb.CreateReadSessionRequest{
    69  //		// TODO: Fill request struct fields.
    70  //		// See https://pkg.go.dev/cloud.google.com/go/bigquery/storage/apiv1/storagepb#CreateReadSessionRequest.
    71  //	}
    72  //	resp, err := c.CreateReadSession(ctx, req)
    73  //	if err != nil {
    74  //		// TODO: Handle error.
    75  //	}
    76  //	// TODO: Use resp.
    77  //	_ = resp
    78  //
    79  // # Use of Context
    80  //
    81  // The ctx passed to NewBigQueryReadClient is used for authentication requests and
    82  // for creating the underlying connection, but is not used for subsequent calls.
    83  // Individual methods on the client use the ctx given to them.
    84  //
    85  // To close the open connection, use the Close() method.
    86  //
    87  // [Authentication and Authorization]: https://pkg.go.dev/cloud.google.com/go#hdr-Authentication_and_Authorization
    88  // [Timeouts and Cancellation]: https://pkg.go.dev/cloud.google.com/go#hdr-Timeouts_and_Cancellation
    89  // [Testing against Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Testing
    90  // [Debugging Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Debugging
    91  // [Inspecting errors]: https://pkg.go.dev/cloud.google.com/go#hdr-Inspecting_errors
    92  package storage // import "cloud.google.com/go/bigquery/storage/apiv1"
    93  
    94  import (
    95  	"context"
    96  
    97  	"google.golang.org/api/option"
    98  )
    99  
   100  // For more information on implementing a client constructor hook, see
   101  // https://github.com/googleapis/google-cloud-go/wiki/Customizing-constructors.
   102  type clientHookParams struct{}
   103  type clientHook func(context.Context, clientHookParams) ([]option.ClientOption, error)
   104  
   105  var versionClient string
   106  
   107  func getVersionClient() string {
   108  	if versionClient == "" {
   109  		return "UNKNOWN"
   110  	}
   111  	return versionClient
   112  }
   113  
   114  // DefaultAuthScopes reports the default set of authentication scopes to use with this package.
   115  func DefaultAuthScopes() []string {
   116  	return []string{
   117  		"https://www.googleapis.com/auth/bigquery",
   118  		"https://www.googleapis.com/auth/bigquery.insertdata",
   119  		"https://www.googleapis.com/auth/cloud-platform",
   120  	}
   121  }
   122  

View as plain text