Skip to content

Commit

Permalink
Clarify the scopes used by BigQueryClient.Create and CreateAsync
Browse files Browse the repository at this point in the history
  • Loading branch information
jskeet committed Jul 15, 2020
1 parent 25710bf commit 909f568
Showing 1 changed file with 32 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,22 @@ public abstract partial class BigQueryClient : IDisposable
/// no credentials are specified.
/// </summary>
/// <remarks>
/// The credentials are scoped as necessary.
/// <para>
/// If the supplied credentials support scoping, the following scopes are specified, overwriting any
/// previously-specified scopes.
/// </para>
/// <list type="bullet">
/// <item><description>https://www.googleapis.com/auth/bigquery"</description></item>
/// <item><description>https://www.googleapis.com/auth/bigquery.insertdata"</description></item>
/// <item><description>https://www.googleapis.com/auth/devstorage.full_control"</description></item>
/// <item><description>https://www.googleapis.com/auth/cloud-platform"</description></item>
/// </list>
/// <para>
/// If you require a different set of scopes, please create and scope the credential,
/// then use <see cref="BigQueryClientBuilder"/>, specify the <see cref="ClientBuilderBase{TClient}.Credential"/>
/// and <see cref="BigQueryClientBuilder.ProjectId"/> properties, then call <see cref="ClientBuilderBase{TClient}.Build"/>
/// to create the client.
/// </para>
/// </remarks>
/// <param name="projectId">The ID of the project containing the BigQuery data. Must not be null.</param>
/// <param name="credential">Optional <see cref="GoogleCredential"/>.</param>
Expand All @@ -104,7 +119,22 @@ public static Task<BigQueryClient> CreateAsync(string projectId, GoogleCredentia
/// no credentials are specified.
/// </summary>
/// <remarks>
/// The credentials are scoped as necessary.
/// <para>
/// If the supplied credentials support scoping, the following scopes are specified, overwriting any
/// previously-specified scopes.
/// </para>
/// <list type="bullet">
/// <item><description>https://www.googleapis.com/auth/bigquery"</description></item>
/// <item><description>https://www.googleapis.com/auth/bigquery.insertdata"</description></item>
/// <item><description>https://www.googleapis.com/auth/devstorage.full_control"</description></item>
/// <item><description>https://www.googleapis.com/auth/cloud-platform"</description></item>
/// </list>
/// <para>
/// If you require a different set of scopes, please create and scope the credential,
/// then use <see cref="BigQueryClientBuilder"/>, specify the <see cref="ClientBuilderBase{TClient}.Credential"/>
/// and <see cref="BigQueryClientBuilder.ProjectId"/> properties, then call <see cref="ClientBuilderBase{TClient}.Build"/>
/// to create the client.
/// </para>
/// </remarks>
/// <param name="projectId">The ID of the project containing the BigQuery data. Must not be null.</param>
/// <param name="credential">Optional <see cref="GoogleCredential"/>.</param>
Expand Down

0 comments on commit 909f568

Please sign in to comment.