Compute Engine v1 API - Class SslPolicies.SslPoliciesClient (2.17.0)

public class SslPolicies.SslPoliciesClient : ClientBase<SslPolicies.SslPoliciesClient>

Reference documentation and code samples for the Compute Engine v1 API class SslPolicies.SslPoliciesClient.

Client for SslPolicies

Inheritance

object > ClientBase > ClientBaseSslPoliciesSslPoliciesClient > SslPolicies.SslPoliciesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

SslPoliciesClient()

protected SslPoliciesClient()

Protected parameterless constructor to allow creation of test doubles.

SslPoliciesClient(CallInvoker)

public SslPoliciesClient(CallInvoker callInvoker)

Creates a new client for SslPolicies that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

SslPoliciesClient(ChannelBase)

public SslPoliciesClient(ChannelBase channel)

Creates a new client for SslPolicies

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

SslPoliciesClient(ClientBaseConfiguration)

protected SslPoliciesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AggregatedList(AggregatedListSslPoliciesRequest, CallOptions)

public virtual SslPoliciesAggregatedList AggregatedList(AggregatedListSslPoliciesRequest request, CallOptions options)

Retrieves the list of all SslPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListSslPoliciesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
SslPoliciesAggregatedList

The response received from the server.

AggregatedList(AggregatedListSslPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual SslPoliciesAggregatedList AggregatedList(AggregatedListSslPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the list of all SslPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListSslPoliciesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
SslPoliciesAggregatedList

The response received from the server.

AggregatedListAsync(AggregatedListSslPoliciesRequest, CallOptions)

public virtual AsyncUnaryCall<SslPoliciesAggregatedList> AggregatedListAsync(AggregatedListSslPoliciesRequest request, CallOptions options)

Retrieves the list of all SslPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListSslPoliciesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSslPoliciesAggregatedList

The call object.

AggregatedListAsync(AggregatedListSslPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SslPoliciesAggregatedList> AggregatedListAsync(AggregatedListSslPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the list of all SslPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name Description
request AggregatedListSslPoliciesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallSslPoliciesAggregatedList

The call object.

CreateOperationsClientForGlobalOperations()

public virtual Operations.OperationsClient CreateOperationsClientForGlobalOperations()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to GlobalOperations.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

Delete(DeleteSslPolicyRequest, CallOptions)

public virtual Operation Delete(DeleteSslPolicyRequest request, CallOptions options)

Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.

Parameters
Name Description
request DeleteSslPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

Delete(DeleteSslPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Delete(DeleteSslPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.

Parameters
Name Description
request DeleteSslPolicyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteAsync(DeleteSslPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteSslPolicyRequest request, CallOptions options)

Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.

Parameters
Name Description
request DeleteSslPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeleteSslPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteSslPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.

Parameters
Name Description
request DeleteSslPolicyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

Get(GetSslPolicyRequest, CallOptions)

public virtual SslPolicy Get(GetSslPolicyRequest request, CallOptions options)

Lists all of the ordered rules present in a single specified policy.

Parameters
Name Description
request GetSslPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
SslPolicy

The response received from the server.

Get(GetSslPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual SslPolicy Get(GetSslPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all of the ordered rules present in a single specified policy.

Parameters
Name Description
request GetSslPolicyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
SslPolicy

The response received from the server.

GetAsync(GetSslPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<SslPolicy> GetAsync(GetSslPolicyRequest request, CallOptions options)

Lists all of the ordered rules present in a single specified policy.

Parameters
Name Description
request GetSslPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSslPolicy

The call object.

GetAsync(GetSslPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SslPolicy> GetAsync(GetSslPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all of the ordered rules present in a single specified policy.

Parameters
Name Description
request GetSslPolicyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallSslPolicy

The call object.

Insert(InsertSslPolicyRequest, CallOptions)

public virtual Operation Insert(InsertSslPolicyRequest request, CallOptions options)

Returns the specified SSL policy resource.

Parameters
Name Description
request InsertSslPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

Insert(InsertSslPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Insert(InsertSslPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified SSL policy resource.

Parameters
Name Description
request InsertSslPolicyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

InsertAsync(InsertSslPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertSslPolicyRequest request, CallOptions options)

Returns the specified SSL policy resource.

Parameters
Name Description
request InsertSslPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertSslPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertSslPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified SSL policy resource.

Parameters
Name Description
request InsertSslPolicyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

List(ListSslPoliciesRequest, CallOptions)

public virtual SslPoliciesList List(ListSslPoliciesRequest request, CallOptions options)

Lists all the SSL policies that have been configured for the specified project.

Parameters
Name Description
request ListSslPoliciesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
SslPoliciesList

The response received from the server.

List(ListSslPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual SslPoliciesList List(ListSslPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all the SSL policies that have been configured for the specified project.

Parameters
Name Description
request ListSslPoliciesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
SslPoliciesList

The response received from the server.

ListAsync(ListSslPoliciesRequest, CallOptions)

public virtual AsyncUnaryCall<SslPoliciesList> ListAsync(ListSslPoliciesRequest request, CallOptions options)

Lists all the SSL policies that have been configured for the specified project.

Parameters
Name Description
request ListSslPoliciesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSslPoliciesList

The call object.

ListAsync(ListSslPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SslPoliciesList> ListAsync(ListSslPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all the SSL policies that have been configured for the specified project.

Parameters
Name Description
request ListSslPoliciesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallSslPoliciesList

The call object.

ListAvailableFeatures(ListAvailableFeaturesSslPoliciesRequest, CallOptions)

public virtual SslPoliciesListAvailableFeaturesResponse ListAvailableFeatures(ListAvailableFeaturesSslPoliciesRequest request, CallOptions options)

Lists all features that can be specified in the SSL policy when using custom profile.

Parameters
Name Description
request ListAvailableFeaturesSslPoliciesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
SslPoliciesListAvailableFeaturesResponse

The response received from the server.

ListAvailableFeatures(ListAvailableFeaturesSslPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual SslPoliciesListAvailableFeaturesResponse ListAvailableFeatures(ListAvailableFeaturesSslPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all features that can be specified in the SSL policy when using custom profile.

Parameters
Name Description
request ListAvailableFeaturesSslPoliciesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
SslPoliciesListAvailableFeaturesResponse

The response received from the server.

ListAvailableFeaturesAsync(ListAvailableFeaturesSslPoliciesRequest, CallOptions)

public virtual AsyncUnaryCall<SslPoliciesListAvailableFeaturesResponse> ListAvailableFeaturesAsync(ListAvailableFeaturesSslPoliciesRequest request, CallOptions options)

Lists all features that can be specified in the SSL policy when using custom profile.

Parameters
Name Description
request ListAvailableFeaturesSslPoliciesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSslPoliciesListAvailableFeaturesResponse

The call object.

ListAvailableFeaturesAsync(ListAvailableFeaturesSslPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SslPoliciesListAvailableFeaturesResponse> ListAvailableFeaturesAsync(ListAvailableFeaturesSslPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all features that can be specified in the SSL policy when using custom profile.

Parameters
Name Description
request ListAvailableFeaturesSslPoliciesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallSslPoliciesListAvailableFeaturesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override SslPolicies.SslPoliciesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
SslPoliciesSslPoliciesClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.SslPolicies.SslPoliciesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchSslPolicyRequest, CallOptions)

public virtual Operation Patch(PatchSslPolicyRequest request, CallOptions options)

Patches the specified SSL policy with the data included in the request.

Parameters
Name Description
request PatchSslPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

Patch(PatchSslPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Patch(PatchSslPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Patches the specified SSL policy with the data included in the request.

Parameters
Name Description
request PatchSslPolicyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

PatchAsync(PatchSslPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchSslPolicyRequest request, CallOptions options)

Patches the specified SSL policy with the data included in the request.

Parameters
Name Description
request PatchSslPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

PatchAsync(PatchSslPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchSslPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Patches the specified SSL policy with the data included in the request.

Parameters
Name Description
request PatchSslPolicyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.