Class BillingAccount (2.55.0)

public final class BillingAccount extends GeneratedMessageV3 implements BillingAccountOrBuilder

A billing account in the Google Cloud Console. You can assign a billing account to one or more projects.

Protobuf type google.cloud.billing.v1.BillingAccount

Static Fields

CURRENCY_CODE_FIELD_NUMBER

public static final int CURRENCY_CODE_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

MASTER_BILLING_ACCOUNT_FIELD_NUMBER

public static final int MASTER_BILLING_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OPEN_FIELD_NUMBER

public static final int OPEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BillingAccount getDefaultInstance()
Returns
Type Description
BillingAccount

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BillingAccount.Builder newBuilder()
Returns
Type Description
BillingAccount.Builder

newBuilder(BillingAccount prototype)

public static BillingAccount.Builder newBuilder(BillingAccount prototype)
Parameter
Name Description
prototype BillingAccount
Returns
Type Description
BillingAccount.Builder

parseDelimitedFrom(InputStream input)

public static BillingAccount parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BillingAccount
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BillingAccount parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BillingAccount
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BillingAccount parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BillingAccount
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BillingAccount parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BillingAccount
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BillingAccount parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BillingAccount
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BillingAccount parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BillingAccount
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BillingAccount parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BillingAccount
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BillingAccount parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BillingAccount
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BillingAccount parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BillingAccount
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BillingAccount parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BillingAccount
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BillingAccount parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BillingAccount
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BillingAccount parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BillingAccount
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BillingAccount> parser()
Returns
Type Description
Parser<BillingAccount>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCurrencyCode()

public String getCurrencyCode()

Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as USD.

Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account.

string currency_code = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The currencyCode.

getCurrencyCodeBytes()

public ByteString getCurrencyCodeBytes()

Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as USD.

Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account.

string currency_code = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for currencyCode.

getDefaultInstanceForType()

public BillingAccount getDefaultInstanceForType()
Returns
Type Description
BillingAccount

getDisplayName()

public String getDisplayName()

The display name given to the billing account, such as My Billing Account. This name is displayed in the Google Cloud Console.

string display_name = 3;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name given to the billing account, such as My Billing Account. This name is displayed in the Google Cloud Console.

string display_name = 3;

Returns
Type Description
ByteString

The bytes for displayName.

getMasterBillingAccount()

public String getMasterBillingAccount()

If this account is a subaccount, then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.

string master_billing_account = 4;

Returns
Type Description
String

The masterBillingAccount.

getMasterBillingAccountBytes()

public ByteString getMasterBillingAccountBytes()

If this account is a subaccount, then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.

string master_billing_account = 4;

Returns
Type Description
ByteString

The bytes for masterBillingAccount.

getName()

public String getName()

Output only. The resource name of the billing account. The resource name has the form billingAccounts/{billing_account_id}. For example, billingAccounts/012345-567890-ABCDEF would be the resource name for billing account 012345-567890-ABCDEF.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the billing account. The resource name has the form billingAccounts/{billing_account_id}. For example, billingAccounts/012345-567890-ABCDEF would be the resource name for billing account 012345-567890-ABCDEF.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getOpen()

public boolean getOpen()

Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it are unable to use paid services.

bool open = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The open.

getParent()

public String getParent()

Output only. The billing account's parent resource identifier. Use the MoveBillingAccount method to update the account's parent resource if it is a organization. Format:

  • organizations/{organization_id}, for example, organizations/12345678
  • billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF

string parent = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Output only. The billing account's parent resource identifier. Use the MoveBillingAccount method to update the account's parent resource if it is a organization. Format:

  • organizations/{organization_id}, for example, organizations/12345678
  • billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF

string parent = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<BillingAccount> getParserForType()
Returns
Type Description
Parser<BillingAccount>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BillingAccount.Builder newBuilderForType()
Returns
Type Description
BillingAccount.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BillingAccount.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BillingAccount.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BillingAccount.Builder toBuilder()
Returns
Type Description
BillingAccount.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException