Discovery Engine v1beta API - Class AclConfigServiceClient (1.0.0-beta24) 

public abstract class AclConfigServiceClient

Reference documentation and code samples for the Discovery Engine v1beta API class AclConfigServiceClient.

AclConfigService client wrapper, for convenient use.

Inheritance

object > AclConfigServiceClient

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Remarks

Service for managing Acl Configuration.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the AclConfigService service, which is a host of "discoveryengine.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default AclConfigService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default AclConfigService scopes are:

GrpcClient

public virtual AclConfigService.AclConfigServiceClient GrpcClient { get; }

The underlying gRPC AclConfigService client

Property Value
Type Description
AclConfigServiceAclConfigServiceClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static AclConfigServiceClient Create()

Synchronously creates a AclConfigServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AclConfigServiceClientBuilder.

Returns
Type Description
AclConfigServiceClient

The created AclConfigServiceClient.

CreateAsync(CancellationToken)

public static Task<AclConfigServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a AclConfigServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AclConfigServiceClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.
Returns
Type Description
TaskAclConfigServiceClient

The task representing the created AclConfigServiceClient.

GetAclConfig(AclConfigName, CallSettings)

public virtual AclConfig GetAclConfig(AclConfigName name, CallSettings callSettings = null)

Gets the [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig].

Parameters
Name Description
name AclConfigName

Required. Resource name of [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig], such as projects/*/locations/*/aclConfig.

If the caller does not have permission to access the [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AclConfig

The RPC response.
Example 
// Create client
AclConfigServiceClient aclConfigServiceClient = AclConfigServiceClient.Create();
// Initialize request argument(s)
AclConfigName name = AclConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
AclConfig response = aclConfigServiceClient.GetAclConfig(name);

GetAclConfig(GetAclConfigRequest, CallSettings)

public virtual AclConfig GetAclConfig(GetAclConfigRequest request, CallSettings callSettings = null)

Gets the [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig].

Parameters
Name Description
request GetAclConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AclConfig

The RPC response.
Example 
// Create client
AclConfigServiceClient aclConfigServiceClient = AclConfigServiceClient.Create();
// Initialize request argument(s)
GetAclConfigRequest request = new GetAclConfigRequest
{
    AclConfigName = AclConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
AclConfig response = aclConfigServiceClient.GetAclConfig(request);

GetAclConfig(string, CallSettings)

public virtual AclConfig GetAclConfig(string name, CallSettings callSettings = null)

Gets the [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig].

Parameters
Name Description
name string

Required. Resource name of [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig], such as projects/*/locations/*/aclConfig.

If the caller does not have permission to access the [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AclConfig

The RPC response.
Example 
// Create client
AclConfigServiceClient aclConfigServiceClient = AclConfigServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/aclConfig";
// Make the request
AclConfig response = aclConfigServiceClient.GetAclConfig(name);

GetAclConfigAsync(AclConfigName, CallSettings)

public virtual Task<AclConfig> GetAclConfigAsync(AclConfigName name, CallSettings callSettings = null)

Gets the [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig].

Parameters
Name Description
name AclConfigName

Required. Resource name of [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig], such as projects/*/locations/*/aclConfig.

If the caller does not have permission to access the [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAclConfig

A Task containing the RPC response.
Example 
// Create client
AclConfigServiceClient aclConfigServiceClient = await AclConfigServiceClient.CreateAsync();
// Initialize request argument(s)
AclConfigName name = AclConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
AclConfig response = await aclConfigServiceClient.GetAclConfigAsync(name);

GetAclConfigAsync(AclConfigName, CancellationToken)

public virtual Task<AclConfig> GetAclConfigAsync(AclConfigName name, CancellationToken cancellationToken)

Gets the [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig].

Parameters
Name Description
name AclConfigName

Required. Resource name of [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig], such as projects/*/locations/*/aclConfig.

If the caller does not have permission to access the [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskAclConfig

A Task containing the RPC response.
Example 
// Create client
AclConfigServiceClient aclConfigServiceClient = await AclConfigServiceClient.CreateAsync();
// Initialize request argument(s)
AclConfigName name = AclConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
AclConfig response = await aclConfigServiceClient.GetAclConfigAsync(name);

GetAclConfigAsync(GetAclConfigRequest, CallSettings)

public virtual Task<AclConfig> GetAclConfigAsync(GetAclConfigRequest request, CallSettings callSettings = null)

Gets the [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig].

Parameters
Name Description
request GetAclConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAclConfig

A Task containing the RPC response.
Example 
// Create client
AclConfigServiceClient aclConfigServiceClient = await AclConfigServiceClient.CreateAsync();
// Initialize request argument(s)
GetAclConfigRequest request = new GetAclConfigRequest
{
    AclConfigName = AclConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
AclConfig response = await aclConfigServiceClient.GetAclConfigAsync(request);

GetAclConfigAsync(GetAclConfigRequest, CancellationToken)

public virtual Task<AclConfig> GetAclConfigAsync(GetAclConfigRequest request, CancellationToken cancellationToken)

Gets the [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig].

Parameters
Name Description
request GetAclConfigRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskAclConfig

A Task containing the RPC response.
Example 
// Create client
AclConfigServiceClient aclConfigServiceClient = await AclConfigServiceClient.CreateAsync();
// Initialize request argument(s)
GetAclConfigRequest request = new GetAclConfigRequest
{
    AclConfigName = AclConfigName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
AclConfig response = await aclConfigServiceClient.GetAclConfigAsync(request);

GetAclConfigAsync(string, CallSettings)

public virtual Task<AclConfig> GetAclConfigAsync(string name, CallSettings callSettings = null)

Gets the [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig].

Parameters
Name Description
name string

Required. Resource name of [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig], such as projects/*/locations/*/aclConfig.

If the caller does not have permission to access the [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAclConfig

A Task containing the RPC response.
Example 
// Create client
AclConfigServiceClient aclConfigServiceClient = await AclConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/aclConfig";
// Make the request
AclConfig response = await aclConfigServiceClient.GetAclConfigAsync(name);

GetAclConfigAsync(string, CancellationToken)

public virtual Task<AclConfig> GetAclConfigAsync(string name, CancellationToken cancellationToken)

Gets the [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig].

Parameters
Name Description
name string

Required. Resource name of [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig], such as projects/*/locations/*/aclConfig.

If the caller does not have permission to access the [AclConfig][google.cloud.discoveryengine.v1beta.AclConfig], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskAclConfig

A Task containing the RPC response.
Example 
// Create client
AclConfigServiceClient aclConfigServiceClient = await AclConfigServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/aclConfig";
// Make the request
AclConfig response = await aclConfigServiceClient.GetAclConfigAsync(name);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.
Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateAclConfig(UpdateAclConfigRequest, CallSettings)

public virtual AclConfig UpdateAclConfig(UpdateAclConfigRequest request, CallSettings callSettings = null)

Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.

Parameters
Name Description
request UpdateAclConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AclConfig

The RPC response.
Example 
// Create client
AclConfigServiceClient aclConfigServiceClient = AclConfigServiceClient.Create();
// Initialize request argument(s)
UpdateAclConfigRequest request = new UpdateAclConfigRequest
{
    AclConfig = new AclConfig(),
};
// Make the request
AclConfig response = aclConfigServiceClient.UpdateAclConfig(request);

UpdateAclConfigAsync(UpdateAclConfigRequest, CallSettings)

public virtual Task<AclConfig> UpdateAclConfigAsync(UpdateAclConfigRequest request, CallSettings callSettings = null)

Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.

Parameters
Name Description
request UpdateAclConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAclConfig

A Task containing the RPC response.
Example 
// Create client
AclConfigServiceClient aclConfigServiceClient = await AclConfigServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateAclConfigRequest request = new UpdateAclConfigRequest
{
    AclConfig = new AclConfig(),
};
// Make the request
AclConfig response = await aclConfigServiceClient.UpdateAclConfigAsync(request);

UpdateAclConfigAsync(UpdateAclConfigRequest, CancellationToken)

public virtual Task<AclConfig> UpdateAclConfigAsync(UpdateAclConfigRequest request, CancellationToken cancellationToken)

Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.

Parameters
Name Description
request UpdateAclConfigRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskAclConfig

A Task containing the RPC response.
Example 
// Create client
AclConfigServiceClient aclConfigServiceClient = await AclConfigServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateAclConfigRequest request = new UpdateAclConfigRequest
{
    AclConfig = new AclConfig(),
};
// Make the request
AclConfig response = await aclConfigServiceClient.UpdateAclConfigAsync(request);