Documentation

DotnetSettings extends Message
in package

Settings for Dotnet client libraries.

Generated from protobuf message google.api.DotnetSettings

Table of Contents

Properties

$common  : mixed
Some settings.
$forced_namespace_aliases  : mixed
Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
$handwritten_signatures  : mixed
Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated.
$ignored_resources  : mixed
List of full resource types to ignore during generation.
$renamed_resources  : mixed
Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions.
$renamed_services  : mixed
Map from original service names to renamed versions.

Methods

__construct()  : mixed
Constructor.
clearCommon()  : mixed
getCommon()  : CommonLanguageSettings|null
Some settings.
getForcedNamespaceAliases()  : RepeatedField
Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
getHandwrittenSignatures()  : RepeatedField
Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated.
getIgnoredResources()  : RepeatedField
List of full resource types to ignore during generation.
getRenamedResources()  : MapField
Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions.
getRenamedServices()  : MapField
Map from original service names to renamed versions.
hasCommon()  : mixed
setCommon()  : $this
Some settings.
setForcedNamespaceAliases()  : $this
Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
setHandwrittenSignatures()  : $this
Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated.
setIgnoredResources()  : $this
List of full resource types to ignore during generation.
setRenamedResources()  : $this
Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions.
setRenamedServices()  : $this
Map from original service names to renamed versions.

Properties

$common

Some settings.

protected mixed $common = null

Generated from protobuf field .google.api.CommonLanguageSettings common = 1 [json_name = "common"];

$forced_namespace_aliases

Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision

private mixed $forced_namespace_aliases

Generated from protobuf field repeated string forced_namespace_aliases = 5 [json_name = "forcedNamespaceAliases"];

$handwritten_signatures

Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated.

private mixed $handwritten_signatures

Snippets calling these methods are still generated, however.

Generated from protobuf field repeated string handwritten_signatures = 6 [json_name = "handwrittenSignatures"];

$ignored_resources

List of full resource types to ignore during generation.

private mixed $ignored_resources

This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"

Generated from protobuf field repeated string ignored_resources = 4 [json_name = "ignoredResources"];

$renamed_resources

Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions.

private mixed $renamed_resources

Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"

Generated from protobuf field map<string, string> renamed_resources = 3 [json_name = "renamedResources"];

$renamed_services

Map from original service names to renamed versions.

private mixed $renamed_services

This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.

Generated from protobuf field map<string, string> renamed_services = 2 [json_name = "renamedServices"];

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type \Google\Api\CommonLanguageSettings $common
      Some settings.
@type array|\Google\Protobuf\Internal\MapField $renamed_services
      Map from original service names to renamed versions.
      This is used when the default generated types
      would cause a naming conflict. (Neither name is
      fully-qualified.)
      Example: Subscriber to SubscriberServiceApi.
@type array|\Google\Protobuf\Internal\MapField $renamed_resources
      Map from full resource types to the effective short name
      for the resource. This is used when otherwise resource
      named from different services would cause naming collisions.
      Example entry:
      "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
@type array<string>|\Google\Protobuf\Internal\RepeatedField $ignored_resources
      List of full resource types to ignore during generation.
      This is typically used for API-specific Location resources,
      which should be handled by the generator as if they were actually
      the common Location resources.
      Example entry: "documentai.googleapis.com/Location"
@type array<string>|\Google\Protobuf\Internal\RepeatedField $forced_namespace_aliases
      Namespaces which must be aliased in snippets due to
      a known (but non-generator-predictable) naming collision
@type array<string>|\Google\Protobuf\Internal\RepeatedField $handwritten_signatures
      Method signatures (in the form "service.method(signature)")
      which are provided separately, so shouldn't be generated.
      Snippets *calling* these methods are still generated, however.

}

getForcedNamespaceAliases()

Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision

public getForcedNamespaceAliases() : RepeatedField

Generated from protobuf field repeated string forced_namespace_aliases = 5 [json_name = "forcedNamespaceAliases"];

Return values
RepeatedField

getHandwrittenSignatures()

Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated.

public getHandwrittenSignatures() : RepeatedField

Snippets calling these methods are still generated, however.

Generated from protobuf field repeated string handwritten_signatures = 6 [json_name = "handwrittenSignatures"];

Return values
RepeatedField

getIgnoredResources()

List of full resource types to ignore during generation.

public getIgnoredResources() : RepeatedField

This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"

Generated from protobuf field repeated string ignored_resources = 4 [json_name = "ignoredResources"];

Return values
RepeatedField

getRenamedResources()

Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions.

public getRenamedResources() : MapField

Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"

Generated from protobuf field map<string, string> renamed_resources = 3 [json_name = "renamedResources"];

Return values
MapField

getRenamedServices()

Map from original service names to renamed versions.

public getRenamedServices() : MapField

This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.

Generated from protobuf field map<string, string> renamed_services = 2 [json_name = "renamedServices"];

Return values
MapField

setForcedNamespaceAliases()

Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision

public setForcedNamespaceAliases(array<string|int, string>|RepeatedField $var) : $this

Generated from protobuf field repeated string forced_namespace_aliases = 5 [json_name = "forcedNamespaceAliases"];

Parameters
$var : array<string|int, string>|RepeatedField
Return values
$this

setHandwrittenSignatures()

Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated.

public setHandwrittenSignatures(array<string|int, string>|RepeatedField $var) : $this

Snippets calling these methods are still generated, however.

Generated from protobuf field repeated string handwritten_signatures = 6 [json_name = "handwrittenSignatures"];

Parameters
$var : array<string|int, string>|RepeatedField
Return values
$this

setIgnoredResources()

List of full resource types to ignore during generation.

public setIgnoredResources(array<string|int, string>|RepeatedField $var) : $this

This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"

Generated from protobuf field repeated string ignored_resources = 4 [json_name = "ignoredResources"];

Parameters
$var : array<string|int, string>|RepeatedField
Return values
$this

setRenamedResources()

Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions.

public setRenamedResources(array<string|int, mixed>|MapField $var) : $this

Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"

Generated from protobuf field map<string, string> renamed_resources = 3 [json_name = "renamedResources"];

Parameters
$var : array<string|int, mixed>|MapField
Return values
$this

setRenamedServices()

Map from original service names to renamed versions.

public setRenamedServices(array<string|int, mixed>|MapField $var) : $this

This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.

Generated from protobuf field map<string, string> renamed_services = 2 [json_name = "renamedServices"];

Parameters
$var : array<string|int, mixed>|MapField
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results