PHPFUI/InstaDoc

Settings for Dotnet client libraries.

Generated from protobuf message google.api.DotnetSettings

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

param array $data { 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.

}

public Google\Protobuf\Internal\Message::__debugInfo()

public Google\Protobuf\Internal\Message::byteSize()

ignore

public Google\Protobuf\Internal\Message::clear()

Clear all containing fields.

return null

public clearCommon()

public Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getCommon()

Some settings.

Generated from protobuf field .google.api.CommonLanguageSettings common = 1;

return \Google\Api\CommonLanguageSettings|null

public getForcedNamespaceAliases()

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

Generated from protobuf field repeated string forced_namespace_aliases = 5;

return \Google\Protobuf\Internal\RepeatedField

public getHandwrittenSignatures()

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.

Generated from protobuf field repeated string handwritten_signatures = 6;

return \Google\Protobuf\Internal\RepeatedField

public getIgnoredResources()

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"

Generated from protobuf field repeated string ignored_resources = 4;

return \Google\Protobuf\Internal\RepeatedField

public 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.

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

Generated from protobuf field map<string, string> renamed_resources = 3;

return \Google\Protobuf\Internal\MapField

public getRenamedServices()

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.

Generated from protobuf field map<string, string> renamed_services = 2;

return \Google\Protobuf\Internal\MapField

public hasCommon()

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

ignore

public Google\Protobuf\Internal\Message::mergeFrom( $msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

param object $msg Protobuf message to be merged from.
return null

public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::mergeFromString( $data)

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Binary protobuf data.
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)

ignore

public Google\Protobuf\Internal\Message::parseFromStream( $input)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)

Serialize the message to json string.

return string Serialized json protobuf data.

public Google\Protobuf\Internal\Message::serializeToStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToString()

Serialize the message to string.

return string Serialized binary protobuf data.

public setCommon( $var)

Some settings.

Generated from protobuf field .google.api.CommonLanguageSettings common = 1;

param \Google\Api\CommonLanguageSettings $var
return $this

public setForcedNamespaceAliases( $var)

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

Generated from protobuf field repeated string forced_namespace_aliases = 5;

param string[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

public setHandwrittenSignatures( $var)

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.

Generated from protobuf field repeated string handwritten_signatures = 6;

param string[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

public setIgnoredResources( $var)

List of full resource types to ignore during generation.

Generated from protobuf field repeated string ignored_resources = 4;

param string[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

public setRenamedResources( $var)

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"

Generated from protobuf field map<string, string> renamed_resources = 3;

param array|\Google\Protobuf\Internal\MapField $var
return $this

public setRenamedServices( $var)

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.

Generated from protobuf field map<string, string> renamed_services = 2;

param array|\Google\Protobuf\Internal\MapField $var
return $this

Properties

protected $common = NULL

Some settings.

Generated from protobuf field .google.api.CommonLanguageSettings common = 1;

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

param array $array An array containing message properties and values.
return null

protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)

protected Google\Protobuf\Internal\Message::readOneof( $number)

protected Google\Protobuf\Internal\Message::readWrapperValue( $member)

protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)

protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)

protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)

Properties

private $forced_namespace_aliases = NULL

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

Generated from protobuf field repeated string forced_namespace_aliases = 5;

private $handwritten_signatures = NULL

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.

Generated from protobuf field repeated string handwritten_signatures = 6;

private $ignored_resources = NULL

List of full resource types to ignore during generation.

Generated from protobuf field repeated string ignored_resources = 4;

private $renamed_resources = NULL

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"

Generated from protobuf field map<string, string> renamed_resources = 3;

private $renamed_services = NULL

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.

Generated from protobuf field map<string, string> renamed_services = 2;